This repository contains the contents for the Avalanche Developer Docs deployed at https://docs.avax.network.
Contributing to the docs site is a great way to get involved with the Avalanche dev community! Here's how to get started:
For small typos or corrections, it is easy to contribute without the need to clone/fork the repository. Simply:
- Find the page you want to edit.
- Click on the "Edit on GitHub" button in the right sidebar
- Make the changes and Hit "Commit changes ..."
- Edit the
commit messageto describe the change in 4 or less words, and include any extra details in the description - Hit "Sign off and commit changes" to raise a PR with your proposed changes
To propose new docs or large edits to our existing pages, follow the steps accordingly:
- Ava Labs Github Organization Members: Clone the repo
git clone https://github.com/ava-labs/avalanche-docs.git - External Contributors: Fork the repo via GitHub's GUI
- Checkout to a new branch
git checkout -b <your-name/branch-name> - Make changes on your branch
git add .yarn devto ensure the build passesgit commit -m "some commit message"git push- Head to GitHub and open a new pull request
- Docs are located in the docs directory.
- Our style guide can be found here.
- All image files should be included under public images folder.
- All PRs should be made against the
masterbranch. - Following a successful build, Vercel will deploy your branch where you can verify your changes.
- Once your PR is merged into
master, https://docs.avax.network/ will be updated with your changes.
yarn installyarn run startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
next buildThis command generates static content into the .next directory and can be rendered using Next server.
The information I am requesting is related to a specific project, i.e. AvalancheGo, AvalancheNetworkRunner, etc.:
- Please raise a Missing Docs Issue in the GitHub repository of that project and thoroughly detail your request. Include references to any existing pages relevant to your request.
The information I am requesting is explanatory in nature and does not currently exist:
- Please open a new Issue in this repository and thoroughly detail your request according to the issue template. If urgent, please create a new ticket in the Dev Docs Improvement Proposals dashboard.
Erroneous or missing information on documentation unrelated to a specific project needs editing: