Skip to content

Latest commit

 

History

History
113 lines (73 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

113 lines (73 loc) · 4.14 KB

Contribution Guidelines

The Documentation team at Avail are the primary maintainers of the Avail Documentation and will review all issues and pull requests created in this repository.

ℹ️ Please make sure to create an issue outlining your feedback/content request for the docs before creating a PR. PRs created without approval will be closed. We are open to technical articles on a wide variety of topics related to Avail and Web3 in general. If you have something in mind, please feel free to jump in with an issue on the repo.

How to Contribute Changes via the Avail Documentation Website

Contributing to the Avail Documentation is simple. You'll need a GitHub account and a basic understanding of Markdown syntax to get started.

  1. Locate the Page: Visit the Avail Documentation page you wish to edit.

  2. Edit Link: Click on the Edit this page link. This will redirect you to the corresponding Markdown file on GitHub.

  3. Edit Mode: Once on GitHub, click the pencil icon located in the upper-right corner to enter edit mode.

  4. Make Edits: Modify the Markdown file as needed.

  5. Initiate Pull Request: Scroll to the bottom and click on Create pull request.

  6. Title Your PR: Give your pull request a descriptive title. For example, if you're editing the "Getting Started" page, you could title it Update /docs/getting-started.md.

  7. Describe Changes: In the pull request description, specify the issue your changes resolve.

    See GitHub Docs on Linking a Pull Request to an Issue for guidance.

  8. Additional Information: Provide a concise summary of the changes you've made. Include screenshots or references if applicable.

  9. Submit: Click Propose changes to finalize your pull request. This will create a new branch in your fork.

How to Locally Run the Avail Documentation

Prerequisites:

  • Node.js (version >= 16.14.1)
  • pnpm Note for macOS Users: Xcode and Command Line Tools are required.

  1. Fork the repository

    See GitHub Docs: Fork a repo for guidance.

  2. Clone your fork

    git clone https://github.com/Genesis3800/docs.git

    This will create a repo named docs in your current directory.

  3. Navigate to the Repository

    cd docs

  4. Add Upstream Remote

    Refer to GitHub Docs: Configuring a remote for a fork.

    git remote add upstream https://github.com/availproject/docs

    ℹ️ You can check if the upstream was added correctly by running git remote -v

  5. Sync Your Fork

    See GitHub Docs: Syncing a fork.

    git checkout main
git fetch upstream
git merge upstream/main

  6. Install Dependencies

    pnpm install

    The site is built using Nextra.

  7. Run the Docs Locally

    pnpm run dev

This will start a local dev derver at http://localhost:3000 on your machine.

Push changes and create PR

Once you are done with all the changes, save all you files and run:

  1. git add .

    to stage all the changes.

  2. git commit -m "Your commit message"

    to commit the changes with ann appropriate commit message.

  3. Once you have committed all the changes, push the changes to your forked repository by running:

    git push origin main

    Now you can use the Github UI to create a PR from your forked repository to the staging branch of the upstream repository.

License

The Avail Project Developer Documentation is licensed under the MIT License free software license.### How to Contribute Changes via the Avail Documentation Website.