Developer documentation hub for the AeThex platform — planned
Find a file
AeThex eb3e84b464
Some checks failed
Deploy Docs / build (push) Failing after 0s
chore: add Vercel, Railway, and CI deployment configuration
2026-05-17 02:33:39 +00:00
.github/workflows chore: add Vercel, Railway, and CI deployment configuration 2026-05-17 02:33:39 +00:00
docs chore: add Vercel, Railway, and CI deployment configuration 2026-05-17 02:33:39 +00:00
.gitignore scaffold: initialize AeThex developer documentation hub with VitePress 2026-05-17 02:01:00 +00:00
nixpacks.toml chore: add Vercel, Railway, and CI deployment configuration 2026-05-17 02:33:39 +00:00
package.json scaffold: initialize AeThex developer documentation hub with VitePress 2026-05-17 02:01:00 +00:00
railway.json chore: add Vercel, Railway, and CI deployment configuration 2026-05-17 02:33:39 +00:00
README.md scaffold: initialize AeThex developer documentation hub with VitePress 2026-05-17 02:01:00 +00:00
vercel.json chore: add Vercel, Railway, and CI deployment configuration 2026-05-17 02:33:39 +00:00

AeThex Docs

The official developer documentation hub for the AeThex ecosystem, built with VitePress.

This covers all AeThex platform products — Forge, Passport, Kite, Studio, Engine, and KAEL — as well as architecture guides, API references, and governance information.

Running Locally

npm install
npm run docs:dev

The dev server will start at http://localhost:5173. Changes to Markdown files hot-reload automatically.

Building

npm run docs:build

Output goes to docs/.vitepress/dist/.

Preview Build

npm run docs:preview

Contributing Docs

  1. Fork this repository and create a branch.
  2. Add or edit Markdown files inside the docs/ directory.
  3. Follow the existing frontmatter conventions (see docs/index.md for the hero page pattern).
  4. Run npm run docs:dev locally to verify your changes render correctly.
  5. Open a pull request to main.

File Structure

docs/
  index.md                   # Landing / hero page
  guide/
    getting-started.md
    architecture.md
  platforms/
    forge.md
    passport.md
    kite.md
    studio.md
    engine.md
    kael.md
  .vitepress/
    config.ts                # VitePress config (nav, sidebar, theme)

Style Guide

  • Use sentence case for headings.
  • Keep code blocks language-tagged (```ts, ```bash, etc.).
  • Cross-link related pages with relative paths: [Passport](../platforms/passport.md).

License

See LICENSE.