feat: Complete VitePress documentation site with pt-BR and English#46
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 compatibilitydocs/.vitepress/config.ts— dual-locale config:root= pt-BR,/en/= English; clean URLs, local search, last-updateddocs/.vitepress/locales/{pt-BR,en}.ts— nav + 3-section sidebars (Guide / Features / Reference) per localedocs/.vitepress/theme/— extends DefaultTheme with brand colors (#2D1B69purple /#F4C430gold), Inter + JetBrains Mono, hero gradient,.pronunciationIPA helper classContent (44 pages)
index.mden/index.mdguia/(7)en/guide/(7)funcionalidades/(11)en/features/(11)referencia/(4)en/reference/(4)Key feature pages: Whisper (offline voice-to-text), Workspace + ACP, Block Comments, Review/
EDITOR=aranduworkflow, Plan phases (idle → planning → reviewing → executing).Deployment & Config
.github/workflows/deploy-docs.yml— triggers ondocs/**push; builds then deploys to Cloudflare Pages (arandu-docsproject) with GitHub Pages fallback.gitignore— excludesdocs/.vitepress/{dist,cache}anddocs/node_moduleswebsite/index.html— "Docs" nav link updated tohttps://docs.arandu.appOriginal 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.appvia Cloudflare Pages + GitHub Pages.Project Structure
Total: 44 pages (22 pt-BR + 22 en)
VitePress Configuration
docs/package.jsondocs:dev,docs:build,docs:previewdocs/.vitepress/config.tslocales: root = pt-BR,/en/= Englishhead: favicon, fonts (Inter + JetBrains Mono via Google Fonts), OG meta, theme-color#2D1B69cleanUrls: true,lastUpdated: truesocialLinks: GitHub reposearch: local provider (built-in)Custom theme (
custom.css)--vp-c-brand-1: #2D1B69(purple), tip borders in gold--vp-c-brand-1: #8B7BC7(light purple), gold accentslinear-gradient(135deg, #F4C430, #D4821E)on the name.pronunciationclass for pronunciation guide with IPASidebar (Vue.js docs-inspired)
Progressive navigation in 3 sections:
Key Page Content
Home (
index.md)layout: homewith hero, 6 feature cards/a.ɾan.ˈdu/— from Guarani, meaning "wisdom"Introduction (
guia/introducao.md)/a.ɾan.ˈdu/<audio>)Whisper (
funcionalidades/whisper.md) ★🔒 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.