alexxnica / docs

Documentation resources for dat and the surrounding ecosystem

Dat Project Documentation

Repository for the documentation of the Dat Project ecosystem. View the docs at docs.dat-data.com.

Writing & Editing Docs

See docs folder for information on editing and adding docs. Once you finish editing the docs, send a PR to the deploy branch to get the edits automatically deployed.

Development

This documentation uses minidocs for layout, ecosystem-docs to get documentation from other modules, and ideas from pull-stream-docs for auto travis deployment.

Viewing Docs Locally

1. Clone Repository
2. npm install
3. npm run build:local to build the docs for local viewing
4. npm run update to update external modules
5. npm run start to view the docs in browser

Deployment

This repository uses netlify for deployment. Deployment will happen automatically.

It works this way:

• Git webhook tells netlify there is new content
• netlify pulls latest repo
• netlify automatically runs npm install
• netlify runs the build script sh scripts/netlify.sh, which:
  • sets git config so we can use ecosystem-docs and pull latests readme files
  • runs npm run netlify which updates remote repos and builds.
• deploys /dist to the web

NPM Commands

Local Docs Preview:

• npm update: update external module readme files
• npm run build:local: build app & css for local viewing
• npm start: start budo server to view locally

Other commands:

• npm run build:css: build css, runs with both build commands
• npm run watch:css: watch css live and build:local with changes
• npm run paper: create the paper with pandoc

License

ISC