Generating chain-specific documentation #29
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
Script generates docs for all listed known chains except rococo (it's being shut down). In dev, they are served separately, to ensure quick feedback in `vocs dev`. In prod, they are rendered right into vocs output dir, for simplicity. Had to hack around vocs a bit, hopefully this won't be required for long.
|
up :) |
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.
Script generates docs for all listed known chains except rococo (it's being shut down).
In dev, they are served separately, to ensure quick feedback in
vocs dev.In prod, they are rendered right into vocs output dir, for simplicity.
Had to hack around vocs a bit, hopefully this won't be required for long.
Question how to update the docs automatically is still not addressed, we might think on it a bit more.
There's no good way to trigger GHA on metadata changes, but we could just regenerate docs once a week.
And, if we're to consider automatic docs regeneration, should we also consider bumping papi version to the latest?
Here's the beta: https://papi-how.ghp.mcornholio.ru/getting-started