Skip to content

availproject/docs

Repository files navigation

Avail Documentation

The Unification Layer for Web3

This is the official documentation repository for Avail. You can find the latest documentation at docs.availproject.org.

Development

  • Avail's docs are built using Nextra V4
  • Nextra V4 in turn is based on Next JS 15, which means this repo's directory structure is based on the app router.

Set up the project locally

  1. Clone the repository locally:
git clone https://github.com/availproject/docs.git
  1. Install the dependencies:
pnpm install
  1. Run the development server:
pnpm dev
  1. By default, the docs will be available at http://localhost:3000.

Contributing

We welcome community contributions to Avail's docs!

Please check out the Contributing Guide for a detailed primer on how to contribute to the Avail documentation.

License

The Avail Project Developer Documentation is licensed under the MIT License free software license.