This repository has been archived by the owner on Jan 22, 2025. It is now read-only.
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.
Problem
The
doc/
directory is unnecessarily siloed, making it difficult to use the book as a starting point to navigating the codebase. You can't tell at a glance what pieces are missing from the book or what version of the codebase the book is describing.Summary of Changes
Integrate the markdown book into the codebase. The book may include additional markdown modules and there may be Rust modules with no corresponding markdown file. The important part here is that if a Rust module exists, the markdown module that describes it will reside in a file next to it.