[Feature Request] Offer documentation as a book #2960
Labels
Priority: Low
Indicates that an issue or pull request should be resolved behind issues or pull requests labelled `
Status: Parked
Indicates that an issues or pull request will be revisited later
Type: Documentation
Indicates a need for improvements or additions to documentation
Type: Enhancement
Indicates new feature requests
Feature Request
Documentation through various
.md
s spread throughout a repository can create difficulty in learning and quickly accessing information. I believe an mdBook akin to the Rust lang book or the serde book would help improve documentation readability and accessibility here.Is this something you would be open to and/or believe would be a worthwhile additional?
Describe the desired solution
In my fork of firecracker I have created a book example draft here.
Describe possible alternatives
A website guide like nalgebra or bevy.
But I believe this is too much and unnecessary, effort when compared to a simple mdBook.
Additional context
This may create considerable duplication of content from various
.md
s throughout the repository, some of this can be circumvented by using having sections of the book simply link to these markdown files e.g.{{#include ../../tests/README.md}}
would insert the content from this file into the book chapter.I think maintaining this duplication is easier than maintaining the janky techniques required to avoid it.
Checks
The text was updated successfully, but these errors were encountered: