Aqua Protocol Documentation

Documentation site for the Aqua Protocol. An open-source cryptographic trust infrastructure for the AI era, providing verifiable identity, access control, and tamper-proof provenance.

Built with Specra and Next.js.

Getting Started

Install dependencies and run the development server:

npm install
npm run dev

Open http://localhost:3000 to view the docs locally.

Project Structure

├── app/                    # Next.js app directory
│   ├── layout.tsx          # Root layout
│   ├── page.tsx            # Landing page
│   └── docs/               # Documentation pages
├── docs/                   # MDX documentation files
│   ├── v1.1.0/             # Version 1.1.0 docs
│   ├── v2.0.2/             # Version 2.0.2 docs
│   ├── v3.0.2/             # Version 3.0.2 docs
│   └── v4.0.0/             # Version 4.0.0 docs (active)
├── public/                 # Static assets
├── scripts/                # Build & indexing scripts
├── specra.config.json      # Site configuration
└── next.config.mjs         # Next.js configuration

Writing Documentation

Add MDX files under the active version directory (docs/v4.0.0):

---
title: My Page
description: This is my documentation page
---

# My Page

Your content here...

Redirects

Redirects are managed in redirects.json. There are two ways to add redirects:

1. Auto-generated redirects

The script scripts/generate-redirects.mjs automatically generates redirects from:

• Frontmatter: Add a redirect_from field to your MDX file:

  ---
  title: My Page
  redirect_from:
    - /docs/v3/old-path
    - /docs/old/other-path
  ---

• Folder redirects: Category folders automatically redirect to their first child page.

Run the script to regenerate:

node scripts/generate-redirects.mjs

2. Manual redirects

You can also add redirects directly to redirects.json. Manual entries are preserved when the script runs — it only adds or updates generated entries without removing manually added ones.

Add an entry with the following format:

{
  "source": "/docs/v4/schema",
  "destination": "/docs/v4.0.0/schema-reference/aqua-tree",
  "permanent": false
}

Field	Description
source	The old URL path that should redirect
destination	The new URL path to redirect to
permanent	true for 301 (permanent), false for 302 (temporary) redirect

Configuration

Edit specra.config.json to customize the site (title, navigation, social links, footer, etc.).

Building for Production

# Standard build (server mode)
npm run build
npm run start

# Static export (GitHub Pages)
npm run build:export

Deployment

The site is configured for GitHub Pages deployment with a custom domain at aqua-protocol.org.

Links

• Aqua Protocol
• GitHub — inblockio
• Next.js Documentation