Layer0 is all about putting power in the hands of developers and our documentation is no different. The source code for the Layer0 developer docs (i.e. this site you're reading now) is in an open repository on GitHub and we welcome feedback and pull requests. If you've found a typo or a better way to explain something, please submit a pull request or file an issue! Others will likely stumble over the same problem and benefit from your insight.
To run the Layer0 docs on your machine, first clone the repository locally,
git clone git@github.com:layer0-docs/layer0-docs.gitThen install the dependencies:
cd layer0-docs
npm installNext, start the Next.js dev server locally,
npm startFinally, visit the site in your browser at http://127.0.0.1:3000.
Layer0 docs is a simple Next.js application running on Layer0 (yes we dogfood). The content is stored as pages called "guides". Each guide is a Markdown file located in the guides folder and guides.json controls the navigation menu for reaching the guides.
If you need to modify an existing guide, you can use the guides.json file to locate the corresponding Markdown file to edit. If your contribution needs its own guide, you'll need to create a new Markdown file in the guides folder and add a reference to it in guides.json.
We recommend the following process for submitting a change:
- Fork the Layer0 Docs repository on GitHub via the web interface.
- Clone the repo and make sure you can run the docs locally.
- Make your amazing edit — even a typo fix is an amazing edit!
- Commit and push your change back to your fork on GitHub.
- Submit a pull request back to the Layer0 Docs repository via GitHub web interface.
For more details, the Pro Git book has a helpful contributing guide that walks you through the process of submitting a pull request to an open source repository on GitHub.