Developer documentation hub for the AeThex platform — planned
|
|
||
|---|---|---|
| .github/workflows | ||
| docs | ||
| .gitignore | ||
| nixpacks.toml | ||
| package.json | ||
| railway.json | ||
| README.md | ||
| vercel.json | ||
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
- Fork this repository and create a branch.
- Add or edit Markdown files inside the
docs/directory. - Follow the existing frontmatter conventions (see
docs/index.mdfor the hero page pattern). - Run
npm run docs:devlocally to verify your changes render correctly. - 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.