Interactive documentation via ijavascript Jupyter notebooks and the hypatia tool - Githubissues

orbitdb-archive / ipfs-log

Append-only log CRDT on IPFS

https://orbitdb.github.io/ipfs-log/

MIT License

398 stars 55 forks source link

Interactive documentation via ijavascript Jupyter notebooks and the hypatia tool #189

Closed aphelionz closed 5 years ago

aphelionz commented 5 years ago

Description

This PR adds two interactive ijavascript Jupyter notebooks to the ./doc folder. We should consider following this convention with our other repos

Usage.ipynb is human-written and is meant to be compelling, helpful content.
API.ipynb is auto-generated (see below) and is meant as a reference.

TODO

[x] Tests passing :tada:
[ ] Gather feedback on Usage.ipynb
[ ] Finish eslint / doctring
[ ] Update README.md with instructions on how to run the notebooks

New Scripts

npm run build:docs : generates and inputs jsdoc file, and outputs ipynb file in docs.

Deps

New dependencies:

The API.ipynb is generated via a tool called hypatia. See here for more details: https://github.com/aphelionz/hypatia

RichardLitt commented 5 years ago

@aphelionz This is still a WIP, right?

aphelionz commented 5 years ago

@RichardLitt Correct. This is one of those pesky things we need to close as discussed yesterday.