Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
bigchaindb/docs/root/source/contributing/ways-to-contribute/write-docs.md
lana-shanghai 4a008e51e3
[WIP] Documentation re-org (#2694) 
* Reorganized docs

* Fixed internal links in basic usage

* fixed the docker-compose command and volume for docs

* fixed docs tests

* fix travis docs test

* tox ini file

* fixed readme localhost links

* edited tox and test docs to previous state

* Fix tests errors related to docs reorganization

Signed-off-by: David Dashyan <mail@davie.li>

* Added ansible script installation option

Signed-off-by: Lana Ivina <lana@ipdb.io>

* Added ansible script to network setup guide

Signed-off-by: Lana Ivina <lana@ipdb.io>

* Hid the non-working button for now. 

Signed-off: Lana Ivina <lana@ipdb.io>

* Try now button

Co-authored-by: David Dashyan <mail@davie.li>
2020-05-18 20:22:26 +07:00

1.4 KiB
Raw Permalink 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 BigchainDB relates to other blockchain things
  • News from recent events

You can certainly do that!

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

The BigchainDB Transactions Specs (one for each spec version) are in the bigchaindb/BEPs 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.