Use mdBook
for the application documentation
#186
josecelano
started this conversation in
Proposals
Replies: 2 comments
-
I guess the only counter-proposal for this one is to merge the #73 and publish a crate. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Alternatives: |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
For now, we have the application documentation on some markdown files in the docs folder:
https://github.com/torrust/torrust-index-frontend/blob/develop/docs/index.md
But we are not publishing it anywhere.
For the tracker and backend, we have the docs on https://docs.rs/.
Since we do not have any Rust crate for this repo, we could use a
mdBook
:https://github.com/rust-lang/mdBook
and publish it to Github Pages.
The documentation for this repo could be extensible if we include here:
cc @da2ce7
Beta Was this translation helpful? Give feedback.
All reactions