Api-Derives documentation generator #6099
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
TarikGul
requested changes
Feb 21, 2025
TarikGul
approved these changes
Feb 21, 2025
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 introduces a custom code parser for
metadataMd.ts, enabling the script to extract code comments from allapi-derivesmodules. This allows us to systematically gather and document information about each available derive.The extracted data is then rendered as Markdown, following the conventions used in other documentation files (e.g., constants, errors, transactions). This ensures that
polkadot-js/docsremains up to date with the latest derives.Note: This is a partial solution. I’ll submit a companion PR later to further expand the
api-derivesdocumentation, as it currently lacks a lot of information. Consequently, the generated documentation in this PR will be somewhat limited.