-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Untrack and auto-generate params.md
on docusaurus_start
#942
base: main
Are you sure you want to change the base?
Conversation
69a4725
to
1aec342
Compare
1aec342
to
4cc92f6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if we keep it in version control but also build it in docusarus_start
?
I'd like to maintain both to avoid "ephemeral docs"
If we do that, there would still be a possibility that version control gets out of sync with what's deployed unless we also add a CI check which |
Wdyt of just adding a TODO to add the check you mentioned (it's ULTRA LOW priority) and closing this PR w/o merging? |
Summary
docusaurus/docs/protocol/governance/params.md
from version control because it is [generated automatically on deployment], which allows the published version to get out of sync with what's in git.docusaurus/docs/protocol/governance/params.md
to.gitignore
so that it ignored going forward.docs_update_gov_params_page
as a dependency to thedocusaurus_start
so thatparams.md
is available when building and serving docusaurus locally.Issue
#933 (review)
Type of change
Select one or more from the following:
consensus-breaking
label if so. See [Infra] Automatically add theconsensus-breaking
label #791 for detailsTesting
make docusaurus_start
; only needed if you make doc changesmake go_develop_and_test
make test_e2e
devnet-test-e2e
label to the PR.Sanity Checklist