Skip to content

feat: Complete VitePress documentation site with pt-BR and English#46

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/create-documentation-site
Draft

feat: Complete VitePress documentation site with pt-BR and English#46
Copilot wants to merge 2 commits intomainfrom
copilot/create-documentation-site

Conversation

Copy link

Copilot AI commented Mar 5, 2026

Arandu had no formal documentation beyond internal READMEs. This adds a full VitePress-based docs site (44 pages, bilingual) deployable to docs.arandu.app.

Structure

  • docs/package.json — isolated VitePress ^1.6.3 setup; "type": "module" required for ESM compatibility
  • docs/.vitepress/config.ts — dual-locale config: root = pt-BR, /en/ = English; clean URLs, local search, last-updated
  • docs/.vitepress/locales/{pt-BR,en}.ts — nav + 3-section sidebars (Guide / Features / Reference) per locale
  • docs/.vitepress/theme/ — extends DefaultTheme with brand colors (#2D1B69 purple / #F4C430 gold), Inter + JetBrains Mono, hero gradient, .pronunciation IPA helper class

Content (44 pages)

Section pt-BR English
Home index.md en/index.md
Guide guia/ (7) en/guide/ (7)
Features funcionalidades/ (11) en/features/ (11)
Reference referencia/ (4) en/reference/ (4)

Key feature pages: Whisper (offline voice-to-text), Workspace + ACP, Block Comments, Review/EDITOR=arandu workflow, Plan phases (idle → planning → reviewing → executing).

Deployment & Config

  • .github/workflows/deploy-docs.yml — triggers on docs/** push; builds then deploys to Cloudflare Pages (arandu-docs project) with GitHub Pages fallback
  • .gitignore — excludes docs/.vitepress/{dist,cache} and docs/node_modules
  • website/index.html — "Docs" nav link updated to https://docs.arandu.app
Original prompt

This section details on the original issue you should resolve

<issue_title>feat: Complete documentation site with VitePress</issue_title>
<issue_description>## Context

Arandu has mature features (Whisper, ACP Workspace, Document Review) but no formal documentation beyond internal READMEs. This issue tracks the creation of a comprehensive documentation site using VitePress, inspired by the Vue.js docs structure and devi.tools aesthetic, deployed to docs.arandu.app via Cloudflare Pages + GitHub Pages.


Project Structure

docs/
├── package.json                    # Isolated (no root package.json in the monorepo)
├── .vitepress/
│   ├── config.ts                   # Central config with locales
│   ├── locales/
│   │   ├── pt-BR.ts               # Sidebar, nav, labels in Portuguese
│   │   └── en.ts                   # Sidebar, nav, labels in English
│   └── theme/
│       ├── index.ts                # Extends default theme
│       └── custom.css              # Brand colors (purple/gold), typography
├── public/
│   ├── icon.svg                    # Copied from shared/icon.svg
│   ├── favicon-32x32.png           # Copied from website/
│   └── apple-touch-icon.png        # Copied from website/
├── index.md                        # pt-BR home (layout: home)
├── guia/
│   ├── introducao.md               # What it is, pronunciation, philosophy
│   ├── instalacao.md               # Homebrew, manual download, all OS
│   ├── inicio-rapido.md            # First steps
│   ├── visualizando-markdown.md    # GFM, syntax highlighting
│   ├── navegacao.md                # Outline sidebar, smooth scroll
│   ├── temas.md                    # Light/dark/system
│   └── atalhos.md                  # Keyboard shortcuts
├── funcionalidades/
│   ├── markdown.md                 # GFM deep dive
│   ├── live-reload.md              # File watching
│   ├── temas.md                    # Theme system, CSS vars
│   ├── whisper.md                  # ★ Voice-to-text, why it matters
│   ├── whisper-config.md           # Models, devices, shortcuts
│   ├── workspace.md                # ★ Workspace concept + ACP
│   ├── sessoes.md                  # Sessions, 6 interaction modes
│   ├── plano.md                    # Plan workflow (idle→planning→reviewing→executing)
│   ├── comentarios.md              # ★ Block comments in markdown
│   ├── review.md                   # ★ Review prompt, EDITOR integration
│   └── integracoes.md              # Shell aliases, IPC, multi-window
├── referencia/
│   ├── cli.md                      # CLI commands
│   ├── ipc.md                      # Unix socket + TCP
│   ├── configuracoes.md            # All settings
│   └── idiomas.md                  # i18n, contributing translations
└── en/                             # English mirror (same structure)
    ├── index.md
    ├── guide/ (7 pages)
    ├── features/ (11 pages)
    └── reference/ (4 pages)

Total: 44 pages (22 pt-BR + 22 en)


VitePress Configuration

docs/package.json

  • VitePress ^1.6.3, Vue ^3.5.13
  • Scripts: docs:dev, docs:build, docs:preview

docs/.vitepress/config.ts

  • locales: root = pt-BR, /en/ = English
  • head: favicon, fonts (Inter + JetBrains Mono via Google Fonts), OG meta, theme-color #2D1B69
  • cleanUrls: true, lastUpdated: true
  • socialLinks: GitHub repo
  • search: local provider (built-in)

Custom theme (custom.css)

  • Brand colors mapped to VitePress CSS vars:
    • Light: --vp-c-brand-1: #2D1B69 (purple), tip borders in gold
    • Dark: --vp-c-brand-1: #8B7BC7 (light purple), gold accents
  • Hero gradient: linear-gradient(135deg, #F4C430, #D4821E) on the name
  • Typography: Inter (body), JetBrains Mono (code)
  • .pronunciation class for pronunciation guide with IPA

Sidebar (Vue.js docs-inspired)

Progressive navigation in 3 sections:

Section Content
Guide Getting Started (3) + Essentials (4)
Features Viewing (3) + Voice (2) + Workspace (3) + Review (3)
Reference CLI, IPC, Configuration, Languages (4)

Key Page Content

Home (index.md)

  • VitePress layout: home with hero, 6 feature cards
  • Pronunciation: arandu /a.ɾan.ˈdu/ — from Guarani, meaning "wisdom"
  • Actions: Get Started, Download, GitHub

Introduction (guia/introducao.md)

  • Three pillars: markdown viewer, AI workspace, review tool
  • Guarani etymology and pronunciation with IPA /a.ɾan.ˈdu/
  • Placeholder for pronunciation audio (future: record and embed <audio>)
  • Design philosophy: monochrome, reading-focused

Whisper (funcionalidades/whisper.md) ★

  • Why it matters: Prompt engineering requires heavy typing. Voice speeds up the workflow
  • whisper.cpp (C++, open-source, offline, no API keys)
  • Model table: tiny→base→small→medium with sizes and recommendations
  • Global shortcut Alt+Space, always-on-top floating window
  • Two modes: field (inline) and button (clipboard)
  • Audio device selection, automatic mode...

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
Copilot AI changed the title [WIP] Add comprehensive documentation site with VitePress feat: Complete VitePress documentation site with pt-BR and English Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress

2 participants