doc: improve documentation layout and list binary formats#116
Merged
Conversation
pleonex
changed the title
priverop
approved these changes
Apr 23, 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.
Description
Re-structure the documentation in three sections:
The home page of the doc was copied from the README and adapted, as users won't need all the repo details (like how to build or where is the doc they are reading). This new simplified home page is also re-used for the nuget readme.
The format specifications have a new summary page that list a bit every format, as well as a new TOC that links to each type.
As a follow-up work we could start splitting the big
texts.mdspec into smaller ones.Also small improvement for CI to prevent running twice the build and test in the main branch.
This closes #97