Rename docs dirs and files to have more digits #3851
Merged
Conversation
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
This makes it possible to insert new pages between existing pages without renaming the existing pages.
bfops
added
release-any
JasonAtClockwork
approved these changes
Dec 9, 2025
Contributor
JasonAtClockwork
left a comment
JasonAtClockwork
left a comment
There was a problem hiding this comment.
LGTM! All tests are passing now
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.
Description of Changes
This makes it possible to insert new pages between existing pages without renaming the existing pages.
I also added a section to docs/README.md with procedure for how to name new pages, which I'll paste here:
Adding new pages
All of our directory and file names are prefixed with a five-digit number which determines how they're sorted.
We started with the hundreds place as the smallest significant digit, to allow using the tens and ones places to add new pages between.
When adding a new page in between two existing pages, choose a number which:
For example, if you want to add a new page between
00300-fooand00400-bar, name it00350-baz. To add a new page between00350-bazand00400-bar, prefer00370-quuxor00380-quux, rather than00375-quux, to avoid populating the ones place.To add a new page after all previous pages, use the smallest multiple of 100 larger than all other pages. For example, if the highest-numbered existing page is
01350-abc, create01400-def.API and ABI breaking changes
N/a
Expected complexity level and risk
1 - @JulienLavocat said this wouldn't break anything.
Testing
None.