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

Contributing to the documents #311

Open
LovelyBuggies opened this issue Feb 25, 2020 · 4 comments
Open

Contributing to the documents #311

LovelyBuggies opened this issue Feb 25, 2020 · 4 comments
Labels
docs Documentation good first issue Good for newcomers

Comments

@LovelyBuggies
Copy link
Collaborator

LovelyBuggies commented Feb 25, 2020

@henryiii , I think we should add more standards for Doc contributing (maybe to add something, e.g. contributing-doc.md or add a new title in CONTRIBUTING.md). When adding new docs, should contributors use file.md or file.rst? Where to put new files? What is the structure or format of the submitted document?

I saw you have "docs": ["Sphinx>=2.0.0", "recommonmark>=0.5.0", "sphinx_rtd_theme"] in setup.py, so I think it's worth broadcasting this specification to other contributors.

@LovelyBuggies
Copy link
Collaborator Author

LovelyBuggies commented Feb 25, 2020

Leave this issue out, if there are no special requirements for sphinx 2.0.0. 🤓

@henryiii
Copy link
Member

I'm sure you are correct. I was mostly focused on development and not on contributions, so I expect some of the docs are too light in that regard.

We should use CONTRIBUTING.md, and I currently use rst for docs since it's a bit more powerful than md (at least in Sphinx).

@LovelyBuggies
Copy link
Collaborator Author

Well done! Expect a more detailed development guideline!

@LovelyBuggies LovelyBuggies changed the title Dev Issue Contributing Docs Feb 25, 2020
@LovelyBuggies LovelyBuggies changed the title Contributing Docs Contributing to the documents Feb 25, 2020
@LovelyBuggies
Copy link
Collaborator Author

LovelyBuggies commented Feb 28, 2020

Another piece of advice for CONTRIBUTING.md: #312 (comment) , my comment on Feb 27, 2020.

@henryiii henryiii added the docs Documentation label Apr 15, 2022
@gohil-jay gohil-jay added the good first issue Good for newcomers label Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation good first issue Good for newcomers
Projects
Status: No status
Development

No branches or pull requests

3 participants