📘 AA Docs

This is documentation site is built with VitePress.

---

📁 Project Structure

docs/
  guide/            → Technical guides
  examples/         → Integration and usage examples
  index.md          → Home page
  support.md        → Community help, contact
.vitepress/
  config.ts         → Site and theme configuration

---

📝 Adding New Docs Pages

1. Create a New Markdown File

Add your .md file to either:

• docs/guide/ for general documentation
• docs/examples/ for code/integration examples

Example:

touch docs/guide/new-feature.md

2. (optional) Add Frontmatter

Add header:

---
title: New Feature
outline: deep  # or 'false' to disable right-hand table of contents
---

Or any other Frontmatter features.

👉 Frontmatter Docs

3. Update the Sidebar

Edit docs/.vitepress/config.ts and add your page to the appropriate section:

sidebar: {
  "/guide/": [
    {
      text: "Guide",
      items: [
        { text: "Tech stack", link: "/guide/tech-stack" },
        { text: "New Feature", link: "/guide/new-feature" } // 👈 Add this
      ]
    }
  ]
}

4. Optional: Add to Navbar

To expose a new top-level page in the navigation:

nav: [
  { text: "New Feature", link: "/guide/new-feature" }
]

---

🚀 Local Development

Start the development server:

npm run docs:dev

Preview your built site:

npm run docs:preview

---

📦 Build for Production

npm run docs:build

---

🚢 Deploy to GitHub Pages

This project uses gh-pages to deploy to GitHub Pages.

Steps

1. Build the site:

   npm run docs:build

2. Deploy to the gh-pages branch:

   npm run deploy

---

🔗 Resources

• VitePress Docs
• Theme Config
• Sidebar Config
• Markdown Guide