♻️ Generate documentation from JSDoc using typedoc #519
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: 47f174d The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
juliencrn
added a commit
that referenced
this pull request
Mar 4, 2024
* Improve JSDoc comments and rename or make private some type aliases * add typedoc to generate docs from jsdoc * refactor scripts related to doc generation * update website to read the new md files instead * Delete removed hooks files * Reword hook summaries to uniformize * Create base v3 migrate page on the docs to list deleted hooks * Create permanent redirections from deleted hooks to migration guide * Add hook's summary to the hook list in the README * Fix lock file
juliencrn
added a commit
that referenced
this pull request
Mar 5, 2024
* Improve JSDoc comments and rename or make private some type aliases * add typedoc to generate docs from jsdoc * refactor scripts related to doc generation * update website to read the new md files instead * Delete removed hooks files * Reword hook summaries to uniformize * Create base v3 migrate page on the docs to list deleted hooks * Create permanent redirections from deleted hooks to migration guide * Add hook's summary to the hook list in the README * Fix lock file
juliencrn
added a commit
that referenced
this pull request
Mar 8, 2024
* 🏗️ Move the full workspace to ES Module (#502) * 🔥 Remove deprecated hooks and co (#503) * ♻️ Prefer type over interface (#515) * ♻️ Generate documentation from JSDoc using typedoc (#519) * 📝 Fix documentation build with some little improvements * 👷 Add "DOM.Iterable" as the code runs in the DOM * 📝 Add Algolia doc search command menu (#513)
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.
The main purpose of this PR is to use JSDoc as the unique source of truth to generate the documentation.
Features:
typedocIt helps