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

Create sphinx style docs for JS-driver and reconcile with Python docs #79

Closed
TimDaub opened this issue Jul 13, 2017 · 3 comments
Closed

Comments

@TimDaub
Copy link
Contributor

TimDaub commented Jul 13, 2017

As a guide line see docs for BDB-PY-driver: https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html

We do not necessarily want all of that content. What I think would be important however is:

That's all for a first cut.

@michielmulders
Copy link
Contributor

michielmulders commented Jul 20, 2017

@TimDaub I recommend moving BigchainDB Root URL to server docs because it's a generic parameter.

Beside that, I would add it to the quickstart: The documentation tells how to set it up, but doesn't give information about verifying to proper installation of a single stand-alone BigchainDB node. Could possibly add:

J. Verify functioning of BigchainDB Server (if you didn't change root url) by surfing to following url: http://127.0.0.1:9984/

This should return an object containing information about api, docs, BDB version and your public key.

@ttmc
Copy link
Contributor

ttmc commented Jul 21, 2017

See bigchaindb/bigchaindb#1687

This was referenced Sep 28, 2017
@future-is-present
Copy link
Contributor

I think we can already close this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants