Dojo reference documentation style guide, how to contribute etc
Opened this issue · 5 comments
Though it may seem trivial I'm missing something like this:
http://dojotoolkit.org/community/styleGuide
specially for reference documentation. It is not my intention to force new contributors to follow style guides for documentation and scare them away, however dojo/doc project is huge and as important as is dojo source. Therefore for best and fastest maintaining probably should follow some guidelines.
I see some major progress and development on this topic and would prefer to leave it for main developers to make something out of it and integrate in the current dojotoolkit.org/get-involved page:
http://oksoclap.com/wqp2YpEMKS
Maybe this is even a topic for two different parts:
- reference documentation style guide
- how to contribute (rstwiki, livedocs.dojotoolkit.org etc)
New users could have some problems with fastest integration in community and contributing to this reference guide.
Thank you for great efforts so far.
Yup, definitely need this. I was about to put it into http://github.com/dojo/docs, based on http://oksoclap.com/wqp2YpEMKS , but then I saw https://github.com/phiggins42/rstwiki/blob/master/sample_data/index.rst and got confused about what should go where.
Hello, just one question:
The following has 4 spaces everywhere:
https://github.com/phiggins42/rstwiki/blob/master/sample_data/index.rst
phiggins42 noted in one of the previous issues that rst stuff have 2 spaces.
Wouldn't be better to simplify and have 4 spaces everywhere in rst files with exception of css code which has 2 spaces because of Dojo convention?
Never mind my note on 2 spaces for css. It uses tabs obviously, so I've meant 4 spaces for everything in reference guide.
I put the style guide and other notes into https://github.com/dojo/docs/blob/master/developer/metadoc.rst. So I think we can close this.
Thanks, @wkeese