Welcome to the Avalanche Developer Docs! Whether you’re a seasoned developer or new to the community, contributing to the documentation can be a rewarding experience. This post will guide you through the process of making contributions to the Avalanche documentation easily and effectively.

Overview of Avalanche Developer Docs

This repository contains the contents for the Avalanche Developer Docs deployed at https://docs.avax.network. Enhancing these docs not only helps you master the platform but also contributes to the greater Avalanche developer community. Let’s dive into how you can make a difference!

How to Contribute

Quick Fixes

For small typos or corrections, it’s easy to contribute without the need to clone or fork the repository. Here’s how:

• 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 message to describe the change in 4 or fewer words, and include any extra details in the description.
• Hit “Sign off” and commit changes to raise a PR with your proposed changes.

New Content or Extensive Changes

If you wish to propose new documentation or make significant edits, follow these steps:

• Ava Labs Github Organization Members: Clone the repo using the command:

git clone https://github.com/ava-labs/avalanche-docs.git

• External Contributors: Fork the repo via GitHub’s GUI.
• Checkout to a new branch with:

git checkout -b your-name/branch-name

• Make your changes on your branch and stage them with:

git add .

• Run yarn dev to ensure the build passes.
• Commit your changes with:

git commit -m "some commit message"

• Push your changes:

git push

• Head to GitHub and open a new pull request.

Understanding the Structure and Syntax

The structure of the documentation is essential. Here’s what you need to know:

• Docs are located in the docs directory.
• You can find our style guide here.
• All image files should be included under the public/images folder.

Submitting a Pull Request

When making a pull request (PR):

• All PRs should be made against the master branch.
• Following a successful build, Vercel will deploy your branch for verification.
• Once your PR is merged into master, https://docs.avax.network will reflect your changes.

Running the Project Locally

To set the project up on your local machine:

bash yarn install

This command installs the necessary dependencies. To start a local development server, use:

bash yarn run start

This will open a browser window to view changes live without needing to restart the server.

Building the Project

To generate static content, run:

bash next build

This command generates content into the .next directory for rendering with the Next server.

Requesting New or Missing Content

If you need new or missing content requests, here’s what you need to do:

• If it’s related to a specific project, raise a Missing Docs Issue in that project’s GitHub repository.
• If the information is explanatory in nature, open a new Issue in this repository.
• For urgent requests, please create a new ticket in the Dev Docs Improvement Proposals dashboard.

Troubleshooting Tips

If you run into any issues, consider the following troubleshooting ideas:

• Verify your commit message format; it should be concise.
• Ensure you have the required permissions to push to the repository.
• Check for any conflicts in your branch before raising a PR.
• If issues persist, reach out for help on the community forums or raise an issue on GitHub.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.