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

[Docs]: Generate book from rust docs #470

Open
MrPicklePinosaur opened this issue Jun 1, 2024 · 0 comments
Open

[Docs]: Generate book from rust docs #470

MrPicklePinosaur opened this issue Jun 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@MrPicklePinosaur
Copy link
Owner

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.

@MrPicklePinosaur MrPicklePinosaur added the documentation Improvements or additions to documentation label Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant