Skip to content

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

Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom
copilot/create-documentation-site
Draft

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

Conversation

CopilotAI commented Mar 5, 2026•
edited
Loading

Copy link
Copy Markdown

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)

Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:

SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.

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

Reviewers

No reviews

Assignees

@wilcorreawilcorrea

Copilot code reviewCopilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress

2 participants

@wilcorrea
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat: Complete VitePress documentation site with pt-BR and English by Copilot · Pull Request #46 · devitools/arandu · GitHub
Skip to content
feat: Complete VitePress documentation site with pt-BR and English - #46
Draft
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Draft
feat: Complete VitePress documentation site with pt-BR and English#46
wilcorrea with Copilot wants to merge 2 commits into
mainfrom 
copilot/create-documentation-site
Conversation
CopilotAI
commented
Mar 5, 2026•

edited

Loading

Copy link


Copy Markdown

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)
Sectionpt-BREnglish
Homeindex.mden/index.md
Guideguia/ (7)en/guide/ (7)
Featuresfuncionalidades/ (11)en/features/ (11)
Referencereferencia/ (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:
SectionContent
GuideGetting Started (3) + Essentials (4)
FeaturesViewing (3) + Voice (2) + Workspace (3) + Review (3)
ReferenceCLI, 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.
@wilcorrea
feat: add VitePress documentation site with pt-BR and English content
6066958
Co-authored-by: wilcorrea <803733+wilcorrea@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add comprehensive documentation site with VitePressfeat: Complete VitePress documentation site with pt-BR and EnglishMar 5, 2026
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees

@wilcorreawilcorrea
Copilot code reviewCopilot

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

feat: Complete documentation site with VitePress


2 participants

@wilcorrea