osaguild / docs.devprotocol.xyz

Documentation for Dev Protocol and the ecosystem

Dev Protocol docs

🙋 💥 👩🏽‍🚀 🚀 👨‍🚀 🛰️

---

Run it quickly

Contributing

If you want to contribute or make fixes to docs, it is best to fork this repository directly and submit pull requests against it. If you spot a typo on the demo/documentation site, you can also open a fork directly from the edit button on the top of each page.

Requirements

• Install Node.js version >= 12.13
• Install Yarn version >= 1.5
• NVM (optional)

To find your current node version:

node --version

Step one

Fork the repo.

For help, refer to GitHub Docs: Fork a repo.

Step two

git clone [email protected]:[your_github_handle]/docs.devprotocol.xyz

Step three

Install the site and run an initial build command:

cd docs.devprotocol.xyz

npm install

npm run build (only necessary the first time!)

If you get errors here, double check your node version!

Step four

Now spin up your local server to see your site!

npm run start

This command will start a local server and you'll be able to work on your site with hot reloads and some nice Browsersync features. 💥

---