chore - generate RFC index from RFC files (#7)#99
Draft
dannymeijer wants to merge 3 commits into
Draft
Conversation
# Conflicts: # Makefile # docs/rfcs/README.md
This file contains hidden or 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
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.
Summary
This PR makes
docs/rfcs/README.mddeterministic by generating the RFC table from the RFC markdown files themselves. It adds an update/check script, a focused CI workflow for stale-index detection, Make targets, and contributor docs for the RFC index workflow.Type of change
docs/rfcs/*)Area(s)
Select the primary areas touched (labels sync from checked lines when the triage workflow runs):
Key details
make rfc-indexafter RFC header changes andmake rfc-index-checkbefore committing.scripts/generate_rfc_index.pyparses eachdocs/rfcs/NNN_*.mdfile for its RFC number, title, and status, then rewrites only the marked generated region indocs/rfcs/README.md.Testing / verification
make ci(ormake fmt-check,make build,make test)Manual verification notes:
make rfc-index-checkpython3 -m py_compile scripts/generate_rfc_index.py.github/workflows/rfc-index.ymlgit diff --check HEAD^..HEADDocs impact
If docs updated:
docs/rfcs/README.md,CONTRIBUTING.mdChecklist
Closes #7