SDK: Improve @dotcms/angular Documentation #30508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rjvelazco
requested review from
fmontes,
oidacra,
nicobytes,
dcolina,
hmoreras,
zJaaal,
valentinogiardino and
jdcmsd
|
jdcmsd
reviewed
Oct 30, 2024
jdcmsd
approved these changes
Oct 30, 2024
valentinogiardino
approved these changes
Oct 30, 2024
zJaaal
approved these changes
Oct 30, 2024
hmoreras
approved these changes
Oct 30, 2024
rjvelazco
deleted the
issue-29212-sdk-improve-dotcmsangular-documentation-v4
branch
dsolistorres
pushed a commit
that referenced
this pull request
Nov 5, 2024
This pull request includes various improvements and corrections to the `core-web/libs/sdk/angular/README.md` file. The changes enhance clarity, correct typographical errors, and provide more detailed troubleshooting steps. Documentation Improvements: * Updated the URL for the Universal Visual Editor to use an absolute link. (`core-web/libs/sdk/angular/README.md`) * Corrected the spelling of "Configuration" in the section header. (`core-web/libs/sdk/angular/README.md`) * Specified the use of `typescript` instead of `javascript` in code examples. (`core-web/libs/sdk/angular/README.md`) [[1]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9L54-R58) [[2]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9R74-R81) Troubleshooting Enhancements: * Expanded the troubleshooting section to include common problems and their solutions, such as dependency issues, configuration errors, network and API errors, page and component rendering, and common Angular errors. (`core-web/libs/sdk/angular/README.md`) Link Corrections: * Updated various links to use absolute URLs for consistency and reliability. (`core-web/libs/sdk/angular/README.md`) [[1]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9R96-R107) [[2]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9L170-R229)
spbolton
pushed a commit
that referenced
this pull request
Nov 11, 2024
This pull request includes various improvements and corrections to the `core-web/libs/sdk/angular/README.md` file. The changes enhance clarity, correct typographical errors, and provide more detailed troubleshooting steps. Documentation Improvements: * Updated the URL for the Universal Visual Editor to use an absolute link. (`core-web/libs/sdk/angular/README.md`) * Corrected the spelling of "Configuration" in the section header. (`core-web/libs/sdk/angular/README.md`) * Specified the use of `typescript` instead of `javascript` in code examples. (`core-web/libs/sdk/angular/README.md`) [[1]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9L54-R58) [[2]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9R74-R81) Troubleshooting Enhancements: * Expanded the troubleshooting section to include common problems and their solutions, such as dependency issues, configuration errors, network and API errors, page and component rendering, and common Angular errors. (`core-web/libs/sdk/angular/README.md`) Link Corrections: * Updated various links to use absolute URLs for consistency and reliability. (`core-web/libs/sdk/angular/README.md`) [[1]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9R96-R107) [[2]](diffhunk://#diff-2ea58ffab81dd236ae02c231ba6908ff8f11b055e2ce79532df0d0765ea5a9a9L170-R229)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes various improvements and corrections to the
core-web/libs/sdk/angular/README.mdfile. The changes enhance clarity, correct typographical errors, and provide more detailed troubleshooting steps.Documentation Improvements:
core-web/libs/sdk/angular/README.md)core-web/libs/sdk/angular/README.md)typescriptinstead ofjavascriptin code examples. (core-web/libs/sdk/angular/README.md) [1] [2]Troubleshooting Enhancements:
core-web/libs/sdk/angular/README.md)Link Corrections:
core-web/libs/sdk/angular/README.md) [1] [2]This PR fixes: #29212