If you are part of the Astar organization on GitHub and have write access to the repository, follow these steps:

Step 1: Set Up Your Local Environment

Clone the repository and navigate to it:

git clone https://github.com/astarnetwork/astar-docs
cd astar-docs

Ensure you are on the main branch and have the latest version:

git checkout main
git pull

Step 2: Create a New Branch

Create a new feature branch for your changes:

git checkout -b feat/your-feature-name

Install dependencies using yarn:

💡 TIP: Use descriptive branch names like feat/update-tokenomics or fix/broken-links.

Step 3: Make Your Changes

Start the local development server to preview your changes in real-time:

This command will launch a local server (typically at http://localhost:3000) where you can see your changes as you edit the documentation.

Make your edits to the documentation files. You should be familiar with:

• Markdown basics: titles, subtitles, lists, hyperlinks, code blocks
• File structure: understanding where different documentation sections are located

Step 4: Test Your Changes

Before committing, ensure the documentation builds without errors:

If the build completes successfully, you are ready to commit your changes.

Step 5: Commit and Push Your Changes

Add your changes and create a commit with a descriptive message:

git add .
git commit -m "Description of your changes"

Push your branch to GitHub:

git push -u origin feat/your-feature-name

💡 TIP: If you need to temporarily save your work without committing, use git stash and later restore with git stash pop.

Step 6: Create a Pull Request

1. Go to https://github.com/astarnetwork/astar-docs
2. Create a new Pull Request from your feature branch to main
3. Provide a detailed description of your changes
4. Once the PR is created, CI/CD will automatically generate a unique staging link for review
5. You can monitor the build progress in the Actions tab on GitHub
6. Wait for feedback from the team

If you are not part of the Astar organization on GitHub, you will need to fork the repository first before making contributions.

Step 1: Fork the Repository

1. Go to https://github.com/astarnetwork/astar-docs
2. Click the Fork button in the top-right corner
3. This creates a copy of the repository under your GitHub account

Step 2: Set Up Your Local Environment

Clone your forked repository (replace YOUR-USERNAME with your GitHub username):

git clone https://github.com/YOUR-USERNAME/astar-docs
cd astar-docs

Add the original repository as an upstream remote to keep your fork synchronized:

git remote add upstream https://github.com/astarnetwork/astar-docs

Step 3: Create a New Branch

Ensure you have the latest changes from the original repository:

git checkout main
git pull upstream main

Create a new feature branch for your changes:

git checkout -b feat/your-feature-name

Install dependencies using yarn:

Step 4: Make Your Changes

Start the local development server to preview your changes in real-time:

This command will launch a local server (typically at http://localhost:3000) where you can see your changes as you edit the documentation.

Make your edits to the documentation files. You should be familiar with:

• Markdown basics: titles, subtitles, lists, hyperlinks, code blocks
• File structure: understanding where different documentation sections are located

Step 5: Test Your Changes

Before committing, ensure the documentation builds without errors:

If the build completes successfully, you are ready to commit your changes.

Step 6: Commit and Push Your Changes

Add your changes and create a commit with a descriptive message:

git add .
git commit -m "Description of your changes"

Push your branch to your forked repository:

git push -u origin feat/your-feature-name

Step 7: Create a Pull Request

1. Go to your forked repository on GitHub (https://github.com/YOUR-USERNAME/astar-docs)
2. Click Compare & pull request
3. Ensure the base repository is astarnetwork/astar-docs and the base branch is main
4. Provide a detailed description of your changes
5. Submit the Pull Request
6. Once the PR is created, CI/CD will automatically generate a unique staging link for review
7. You can monitor the build progress in the Actions tab on GitHub
8. Wait for feedback from the Astar team

Step 8: Keep Your Fork Updated

To keep your fork synchronized with the original repository:

git checkout main
git pull upstream main
git push origin main