AIVEN-DOCS

README

Aiven docs

The Aiven docs repo generates the content located at www.aiven.io/docs. We use Docusaurus to build the docs.

🤲 Contributing

We welcome contributions! To contribute to our docs, see Contributing.

️🚀 Building the docs

1. Update the examples submodule:

   git submodule update --init --recursive
   

With Docker

1. Run:

   docker compose up dev
   

2. Go to http://localhost:3000/docs/. Updating files in your local repo refreshes the website.

Without Docker

Requirements

• Node ≥ 23
• yarn 4

1. Install the dependencies:

   corepack enable
   yarn
   

2. Optional: Install Vale.

3. Optional: Install Husky:

   yarn dlx husky
   

   Husky prevents git pushes when Vale errors are in the files you've modified.

4. Build the docs:

   yarn start
   

   💡 Tip: If you use VS Code, you can use the build task: ⌘+⇧+B > Build the docs

5. Go to http://localhost:3000/docs/. Updating files in the local repo refreshes the website.

Opening a PR

1. Check for potential broken links with yarn build (yarn start doesn't check for broken links). After the Docusaurus build, scripts/limit-llms-txt-size.mjs keeps build/llms.txt under 48,000 characters and links to the full index at llms-full.txt, so agents can use a compact index without hitting tooling limits (for example ~100K truncation checks).
2. If you get a green build and when you are happy with your changes, open a PR.