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

Add Contributing and History content to sphinx documentation #94

Open
danwos opened this issue Oct 23, 2019 · 1 comment
Open

Add Contributing and History content to sphinx documentation #94

danwos opened this issue Oct 23, 2019 · 1 comment

Comments

@danwos
Copy link
Contributor

danwos commented Oct 23, 2019

Is it okay to add developer related content (like contributing, history, contributors, ... ) also as page to the sphinx documentation of wily?

This would have the benefit that there is only one single source of information and it would also give a good first impression of the project setup or its quality.

A rough idea about how it would look like can give the sphinx-needs docs: https://sphinxcontrib-needs.readthedocs.io/en/latest
There all developer related pages are added below the pages for the normal user.

You may like it or hate it, I understand both positions :)
Therefore this question before I create a hopeless PR.

@tonybaloney
Copy link
Owner

Sounds great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants