Mirroristas/planetmint
2
0
Fork 0
mirror of https://github.com/planetmint/planetmint.git synced 2025-03-30 15:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
planetmint/docs/root/source/contributing/ways-to-contribute/write-docs.md
Sangat Das fd48880630
Resolves #20 (#47) 
* Integrate zenroom acceptance test

* fixed zenroom reference

* added additional dependences to the docker fils so that zenroom can be executed.
added zenroom from git repo, because pypi servs an older buggy version

* using the custom planetmintdriver branch to avoid pypi zendesk downloads

* Added zenroom test

* Added zenroom test

Signed-off-by: Sangat Das <sangatdas5@gmail.com>

* Change reference to planetmint-driver to planetmint-driver-python

Signed-off-by: Sangat Das <sangatdas5@gmail.com>

Co-authored-by: Jürgen Eckel <juergen@riddleandcode.com>
2022-02-21 10:59:09 +01:00

1.4 KiB
Raw Blame History

Write Docs

If you're writing code, you should also update any related docs. However, you might want to write docs only, such as:

  • General explainers
  • Tutorials
  • Courses
  • Code explanations
  • How Planetmint relates to other blockchain things
  • News from recent events

You can certainly do that!

  • The docs for Planetmint Server live under planetmint/docs/ in the planetmint/planetmint repo.
  • There are docs for the Python driver under planetmint-driver/docs/ in the planetmint/planetmint-driver-python repo.
  • There are docs for the JavaScript driver under planetmint/js-bigchaindb-driver in the planetmint/js-bigchaindb-driver repo.
  • The source code for the Planetmint website is in a private repo, but we can give you access if you ask.

The Planetmint Transactions Specs (one for each spec version) are in the planetmint/PEPs repo.

You can write the docs using Markdown (MD) or RestructuredText (RST). Sphinx can understand both. RST is more powerful.

ReadTheDocs will automatically rebuild the docs whenever a commit happens on the master branch, or on one of the other branches that it is monitoring.