docs(generation): fix docs generation issue #29
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
- Update typedoc.json. - Update `entryPoint` to `src`. - Use `expand` `entryPointStrategy` to convert entry points into documentation modules. - Update generate-docs.sh script to remove auto-generated README.md files at root of every generated module. - Ignore docusaurus broken-markdown-link warning due to missing README. - Delete custom-output plugin. - Plugin no longer needed with new generation strategy. - Use default naming to match docs file structure with src.
- Update `onBrokenLinks` to `ignore`. - Prevent docusaurus warnings on build.
ishaan000
approved these changes
Jan 9, 2025
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 PR fixes the docs generation issue that was generating documentation for only one file. Documentation can now be generated for all files with /docs matching the file structure of /src. This is done with the following changes,
entryPointtosrc.expandentryPointStrategyto convert entry points into documentation modules.Documentation has been created for the entire project. Note that most of it is incomplete. To see what documentation should look like when complete, see /hooks.