firecracker icon indicating copy to clipboard operation
firecracker copied to clipboard

[Feature Request] Offer documentation as a book

Open JonathanWoollett-Light opened this issue 2 years ago • 0 comments

Feature Request

Documentation through various .mds 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 .mds 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

  • [x] Have you searched the Firecracker Issues database for similar requests?
  • [x] Have you read all the existing relevant Firecracker documentation?
  • [x] Have you read and understood Firecracker's core tenets?

JonathanWoollett-Light avatar Apr 13 '22 10:04 JonathanWoollett-Light