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

Include CONTRIBUTING.md into the generated docs #155

Open
JOJ0 opened this issue Sep 14, 2024 · 0 comments
Open

Include CONTRIBUTING.md into the generated docs #155

JOJ0 opened this issue Sep 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@JOJ0
Copy link
Owner

JOJ0 commented Sep 14, 2024

but at the same time keep it as a plain MD formatted file in the root of the git repo, which fits with the (quasi) standard we see in other git (github?) repos.

Motivation and thoughts: When I look at our generated docs at https://synadm.readthedocs.io (https://synadm.rtfd.io), it always feels like developers documentation is entirely missing. We are not even linking to it. In my opinion one well formatted documentation "entry point" is a goal. It would also support the current efforts to simplify README.md as much as possible. We can always link to the generated Sphinx docs from there. The same goes for the elsewhere discussed TROUBLESHOOTING.md, I suggest to also incorporate this into the generated docs and link to it from wherever we see fit.

@JOJ0 JOJ0 added the documentation Improvements or additions to documentation label Sep 14, 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