MrPicklePinosaur / shrs

The rusty shell toolkit for hackers
https://mrpicklepinosaur.github.io/shrs/
Apache License 2.0
301 stars 24 forks source link

[Docs]: Generate book from rust docs #470

Open MrPicklePinosaur opened 3 months ago

MrPicklePinosaur commented 3 months ago

How can the documentation be improved?

We have recently added a lot of tutorial and explanations to each module in shrs source code as the source of truth. This also means that a lot of things are now duplicated between the actual source code docstrings and the book. Should figure out a way to have a single source of truth for docs, which perhaps means generating the book automatically from docstrings.