Clean up the structure of the Sphinx documentation#4314
Open
RobertBrunel wants to merge 1 commit into
Open
Conversation
RobertBrunel
commented
Jun 30, 2026
RobertBrunel
commented
Contributor
- Group the table-of-contents pages under section headers: User Guide, Reference, and Development.
- Normalize page titles to sentence case and drop the redundant “FoundationDB Record Layer” prefix; rename a few for clarity.
- Reword and fix typos in some page intros.
- Drop “documentation” from the sidebar title to save space.
- Move the License entry from the table of contents into the footer of every page.
* Group the table-of-contents pages under section headers: User Guide, Reference, and Development. * Normalize page titles to sentence case and drop the redundant “FoundationDB Record Layer” prefix; rename a few for clarity. * Reword and fix typos in some page intros. * Drop “documentation” from the sidebar title to save space. * Move the License entry from the table of contents into the footer of every page.
arnaud-lacurie
approved these changes
Jul 1, 2026
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
2 participants
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.