Add contributing documentation #319
Conversation
JakeSCahill
changed the title
| <summary>Contribute to the documentation :black_nib:</summary> | ||
| <br> | ||
|
|
||
| The Python client library documentation is hosted on https://docs.iota.org, which is built from content in the [documentation](https://github.com/iotaledger/documentation) repository. |
There was a problem hiding this comment.
❔ Just confirming, are we planning to migrate docs directory in this project to the documentation repo?
There was a problem hiding this comment.
Eventually, yes I think that would be a good idea.
There was a problem hiding this comment.
Indeed, that would be great!
@JakeSCahill do you have any suggestions how to make this happen? The complete documentation is built via sphinx from .rst files, and I'm afraid rewriting everything into .md files for docs.iota.org would mean abandoning sphinx, and hence loosing automatic doc generation from source code. Sphinx is essential for maintainable python documentation.
Or could we create a custom html theme for shpinx in order to include the output html files directly into iotaledger/documentation?
Another option would be to create a new md file specifically for the docs site with only the API methods (core + extended), but leave the in depth-documentation at https://pyota.readthedocs.io/en/latest/ .
What do you think?
| <li>We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date.</li> | ||
| <li>If you have followed the instructions above, we will not take any legal action against you in regard to the report.</li> | ||
| <li>We will keep you informed during all stages of resolving the problem.</li> | ||
| <li>To show our appreciation for your effort and cooperation during the report, we will list your name and a link to a personal website/social network profile on the page below so that the public can know you've helped keep the IOTA Foundation secure.</li> |
There was a problem hiding this comment.
❔ Which page will the contributor links appear on?
There was a problem hiding this comment.
I'm not sure. This was written by our security specialist @karimodm
Maybe this should say on this page?
Co-Authored-By: Phoenix <[email protected]>
| <summary>Contribute to the documentation :black_nib:</summary> | ||
| <br> | ||
|
|
||
| The Python client library documentation is hosted on https://docs.iota.org, which is built from content in the [documentation](https://github.com/iotaledger/documentation) repository. |
There was a problem hiding this comment.
Indeed, that would be great!
@JakeSCahill do you have any suggestions how to make this happen? The complete documentation is built via sphinx from .rst files, and I'm afraid rewriting everything into .md files for docs.iota.org would mean abandoning sphinx, and hence loosing automatic doc generation from source code. Sphinx is essential for maintainable python documentation.
Or could we create a custom html theme for shpinx in order to include the output html files directly into iotaledger/documentation?
Another option would be to create a new md file specifically for the docs site with only the API methods (core + extended), but leave the in depth-documentation at https://pyota.readthedocs.io/en/latest/ .
What do you think?
Co-Authored-By: Phoenix <[email protected]>
Add docs to .github directory to keep the repo tidy.
Updates the templates to use the latest GitHub features.