Skip to content

feat: better docs #2563

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
Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

feat: better docs #2563

wants to merge 6 commits into from

Conversation

axe312ger
Copy link
Collaborator

@axe312ger axe312ger commented Feb 28, 2025 •
edited
Loading

We plan to finally get the docs of this repository into a good shape. Addressing plenty of complaints:

Goals

  • clean up config and update typedocs
  • (ongoing) improving current jsdocs comments
  • ensure all types and interfaces are available, so people finally can fully dig around
  • ensure already included examples are actually rendered
  • clear introduction of both client types
  • soft deprecation of legacy chainable client
  • clear separation in navigation between plain and chainable client
  • reintroduce structure for legacy client like in v4 and v5
  • introduce a version selector
  • potentially deprecate/discontinue outdated theme https://github.com/contentful/contentful-sdk-jsdoc/ and migrating https://github.com/contentful/contentful-sdk-jsdoc/blob/master/bin/publish-docs.sh directly into this repo, either as circleci action or github workflow

@AlanSl AlanSl mentioned this pull request Apr 7, 2025
Open
axe312ger
axe312ger commented Apr 24, 2025
View reviewed changes
typedoc.json
"name": "contentful-management.js",
"entryPoints": [
"lib/contentful-management.ts",
// "lib/plain/plain-client.ts",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note to myself: remove this commented out files!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@axe312ger