Replace README API docs with generated docs #213
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
The API documentation in the README has been replaced with GitHub-pages hosted documentation generated using TypeDoc. The `@MetaMask/action-publish-gh-pages` action is used for the publish step. The action configuration is taken nearly exactly from the README example for that action, except that the build command and directory are updated, and the `yarn setup` step has been added (because TypeDoc needs to be installed). A new `docs:publish` npm script has been added to ensure the output directory doesn't get cleaned (because it includes the `git worktree` setup by the `@MetaMask/action-publish-gh-pages` action), and to set the correct git revision. These docs will only be published when the package is released, rather than the latest development version. Instructions have been added to the contributing section showing how to generate and view the API documentation for the current commit. The old README API documentation has been reviewed and incorporated into the inline documentation. Minor adjustments and improvements have been made to ensure that no information is lost.
|
I deployed and tested this on my fork, which you can see here: https://gudahtt.github.io/eth-sig-util/index.html |
rekmarks
added a commit
to MetaMask/utils
that referenced
this pull request
May 15, 2022
Adds automated API docs generation via `typedoc` and automated publishing to GitHub pages. Closely follows the implementation in MetaMask/eth-sig-util#207 and MetaMask/eth-sig-util#213, but uses https://github.com/peaceiris/actions-gh-pages instead of our own GitHub Pages action, which we plan to sunset.
mcmire
pushed a commit
to mcmire/core
that referenced
this pull request
Jul 17, 2023
Adds automated API docs generation via `typedoc` and automated publishing to GitHub pages. Closely follows the implementation in MetaMask/eth-sig-util#207 and MetaMask/eth-sig-util#213, but uses https://github.com/peaceiris/actions-gh-pages instead of our own GitHub Pages action, which we plan to sunset.
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 API documentation in the README has been replaced with GitHub-pages hosted documentation generated using TypeDoc.
The
@MetaMask/action-publish-gh-pagesaction is used for the publish step. The action configuration is taken nearly exactly from the README example for that action, except that the build command and directory are updated, and theyarn setupstep has been added (because TypeDoc needs to be installed).A new
docs:publishnpm script has been added to ensure the output directory doesn't get cleaned (because it includes thegit worktreesetup by the@MetaMask/action-publish-gh-pagesaction), and to set the correct git revision.These docs will only be published when the package is released, rather than the latest development version. Instructions have been added to the contributing section showing how to generate and view the API documentation for the current commit.
The old README API documentation has been reviewed and incorporated into the inline documentation. Minor adjustments and improvements have been made to ensure that no information is lost.
Closes #47