Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(SDK: dotcms client): Improve JS Client README.md #30677

Merged
merged 2 commits into from
Nov 15, 2024
Merged

chore(SDK: dotcms client): Improve JS Client README.md #30677

merged 2 commits into from
Nov 15, 2024

Conversation

rjvelazco
Copy link
Contributor

@rjvelazco rjvelazco commented Nov 15, 2024 •
edited by github-actions bot
Loading

This pull request includes significant updates to the core-web/libs/sdk/client/README.md file to improve the documentation for the DotCMS API Client. The changes include a more detailed introduction, additional usage examples, and comprehensive instructions for using various methods of the client.

Documentation improvements:

  • Updated the introduction to provide a clearer description of the @dotcms/client library and its capabilities.
  • Added detailed usage examples for fetching pages, navigation, and collections of content, including complex queries, sorting, filtering by language, and handling draft content.
  • Included an example for error handling to demonstrate how to manage errors gracefully using a try-catch block.
  • Expanded the API reference section to include the getCollection method and its parameters, return values, and usage.

This PR fixes: #30614

@rjvelazco rjvelazco linked an issue Nov 15, 2024 that may be closed by this pull request
SDK: Improve JS Client Readme #30614
Closed
@github-actions github-actions bot mentioned this pull request Nov 15, 2024
Closed
@rjvelazco rjvelazco changed the title Issue 30614 sdk improve js client readme chore(SDK: dotcms client): Improve JS Client README.md Nov 15, 2024
@rjvelazco rjvelazco marked this pull request as ready for review November 15, 2024 19:17
@dotcms-sonarqube dotCMS-sonarqube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@rjvelazco rjvelazco added this pull request to the merge queue Nov 15, 2024
Merged via the queue into main with commit 656775a Nov 15, 2024
23 checks passed
@rjvelazco rjvelazco deleted the issue-30614-sdk-improve-js-client-readme branch November 15, 2024 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@valentinogiardino valentinogiardino valentinogiardino approved these changes

@zJaaal zJaaal zJaaal approved these changes

@oidacra oidacra oidacra approved these changes

@fmontes fmontes Awaiting requested review from fmontes

@nicobytes nicobytes Awaiting requested review from nicobytes

@hmoreras hmoreras Awaiting requested review from hmoreras

@KevinDavilaDotCMS KevinDavilaDotCMS Awaiting requested review from KevinDavilaDotCMS

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

SDK: Improve JS Client Readme
4 participants
@rjvelazco @oidacra @zJaaal @valentinogiardino