Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Offer documentation as a book #2960

Open
3 tasks done
JonathanWoollett-Light opened this issue Apr 13, 2022 · 0 comments
Open
3 tasks done

[Feature Request] Offer documentation as a book #2960

JonathanWoollett-Light opened this issue Apr 13, 2022 · 0 comments
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

Comments

@JonathanWoollett-Light
Copy link
Contributor

JonathanWoollett-Light commented Apr 13, 2022

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

  • Have you searched the Firecracker Issues database for similar requests?
  • Have you read all the existing relevant Firecracker documentation?
  • Have you read and understood Firecracker's core tenets?
@JonathanWoollett-Light JonathanWoollett-Light changed the title [Feature Request] Consolidate/offer documentation into/as a book [Feature Request] Offer documentation as a book Apr 13, 2022
@JonathanWoollett-Light JonathanWoollett-Light added Type: Documentation Indicates a need for improvements or additions to documentation and removed Documentation: Design labels Mar 23, 2023
@ShadowCurse ShadowCurse added Priority: Low Indicates that an issue or pull request should be resolved behind issues or pull requests labelled ` Type: Enhancement Indicates new feature requests Status: Parked Indicates that an issues or pull request will be revisited later labels Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants