DataHighway Documentation

Welcome to the DataHighway Developer Hub documentation. We're just getting started, so our documentation is still incomplete.

Contributing

Refer to CONTRIBUTING.md for details about:

• Creating Issues
• Creating Pull Requests

Maintenance

Refer to MAINTENANCE.md for details about:

• Updating the DataHighway Whitepaper
• Updating the DataHighway Documentation Website
• Deploying updates

Running & Viewing Documentation Locally

Install Node >=12.13.0, then run the following commands to install dependencies and start build the website. Optionally Obtain Algolia API keys to enable "search". Run the following, then paste them in the .env file.

cp .env.example .env

Run the following commands to install dependencies and start build the website.

yarn install && yarn start

View in web browser http://localhost:3000

Adding a New Document

• Create your markdown document in a suitable directory inside /docs.
• If you have images in your document, put them in the /docs/images/ directory.