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.

Sign up for GitHub

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

Jump to bottom

[FW-A-29] Create project documentation in markdown using mdbook #20

Open
John15321 opened this issue Aug 14, 2022 · 0 comments
Open

[FW-A-29] Create project documentation in markdown using mdbook #20

John15321 opened this issue Aug 14, 2022 · 0 comments
Labels
Documentation Improvements or additions to documentation New feature New feature or request
Milestone
📖 Documentation

Comments

@John15321
Copy link
Member

John15321 commented Aug 14, 2022 •
edited
Loading

mdBook is a template for creating documentation in markdown. It is mainly used for rust projects, but the template just like markdown itself is language agnostic, it's just a markup language. Start creating documentation for the project using it (in the future it would be accessible by github.io
https://github.com/rust-lang/mdBook

Part of:

Related to:
@John15321 John15321 added Documentation Improvements or additions to documentation New feature New feature or request labels Aug 14, 2022
@John15321 John15321 mentioned this issue Aug 15, 2022
Open
@John15321 John15321 changed the title [TBD] Create project documentation in markdown using mdbook [FW-A-29] Create project documentation in markdown using mdbook Aug 15, 2022
@John15321 John15321 added this to the 📖 Firmware documentation milestone Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation New feature New feature or request
Projects
None yet
Milestone
📖 Documentation
Development

No branches or pull requests
1 participant
@John15321