vibetunnel/docs.json
Peter Steinberger bb52efdcf2 Clean up and improve documentation across the project
- Add Linux/headless support documentation to introduction.mdx and project-overview.md
- Fix sidebar navigation with descriptive titles instead of generic README labels
- Remove experimental Tauri references from docs.json
- Reorganize docs.json with better categorization and all relevant files
- Keep architecture-mario.md and consolidated org-migrate.md as TODO
2025-07-19 03:01:48 +02:00

198 lines
No EOL
4.6 KiB
JSON

{
"$schema": "https://mintlify.com/schema.json",
"name": "VibeTunnel",
"theme": "maple",
"logo": {
"dark": "/docs/images/vibetunnel-logo-dark.svg",
"light": "/docs/images/vibetunnel-logo-light.svg"
},
"favicon": "/docs/images/favicon.svg",
"colors": {
"primary": "#0066FF",
"light": "#3B82F6",
"dark": "#1E40AF"
},
"topbarLinks": [
{
"name": "Support",
"url": "https://discord.gg/vibetunnel"
}
],
"topbarCtaButton": {
"name": "Download",
"url": "https://vibetunnel.com/download"
},
"tabs": [
{
"name": "Documentation",
"url": "docs"
},
{
"name": "GitHub",
"url": "https://github.com/amantus-ai/vibetunnel"
}
],
"anchors": [
{
"name": "GitHub",
"icon": "github",
"url": "https://github.com/amantus-ai/vibetunnel"
},
{
"name": "Discord",
"icon": "discord",
"url": "https://discord.gg/vibetunnel"
}
],
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": [
"introduction",
"docs/INDEX",
"docs/project-overview",
"docs/keyboard-shortcuts",
"docs/CONTRIBUTING",
"CHANGELOG"
]
},
{
"group": "Installation",
"pages": [
{
"title": "macOS Installation",
"href": "mac/README"
},
{
"title": "iOS Installation",
"href": "ios/README"
},
"web/docs/VT_INSTALLATION",
"docs/custom-node"
]
},
{
"group": "Architecture",
"pages": [
"docs/ARCHITECTURE",
"docs/architecture-mario",
"docs/spec",
"docs/ios-spec",
"web/docs/spec",
"mac/docs/BuildArchitectures",
"web/docs/socket-protocol",
"docs/authentication",
"docs/security"
]
},
{
"group": "Advanced Features",
"pages": [
"docs/hq",
"docs/push-notification",
"web/docs/terminal-titles",
"docs/TESTING_EXTERNAL_DEVICES"
]
},
{
"group": "Development",
"pages": [
"docs/development",
"docs/build-system",
"docs/testing",
"docs/logging-style-guide",
"docs/files"
]
},
{
"group": "macOS Development",
"pages": [
"mac/docs/BuildRequirements",
"mac/docs/code-signing",
"mac/docs/RELEASE_GUIDE",
"mac/docs/sparkle-keys",
"mac/docs/sparkle-stats-store"
]
},
{
"group": "iOS Development",
"pages": [
"ios/conversion",
"apple/docs/modern-swift",
"apple/docs/swift-concurrency",
"apple/docs/swiftui",
"apple/docs/swift-testing-playbook",
"apple/docs/logging-private-fix"
]
},
{
"group": "iOS Testing",
"pages": [
{
"title": "Test Suite Overview",
"href": "ios/VibeTunnelTests/README"
},
"ios/VibeTunnelTests/TestCoverage",
"ios/VibeTunnelTests/TestingApproach"
]
},
{
"group": "Web Development",
"pages": [
{
"title": "Web Frontend Guide",
"href": "web/README"
},
"web/docs/performance",
"web/docs/playwright-testing",
"web/src/test/playwright/SEQUENTIAL_OPTIMIZATIONS",
"web/docs/npm"
]
},
{
"group": "Release & Deployment",
"pages": [
"docs/deployment",
"docs/RELEASE"
]
},
{
"group": "Tools & Integration",
"pages": [
"docs/claude",
"CLAUDE",
"docs/gemini",
"GEMINI",
{
"title": "GitHub Actions Guide",
"href": ".github/workflows/README"
}
]
},
{
"group": "Maintenance",
"pages": [
"docs/org-migrate"
]
}
]
},
"footerSocials": {
"twitter": "https://twitter.com/vibetunnel",
"github": "https://github.com/amantus-ai/vibetunnel",
"discord": "https://discord.gg/vibetunnel"
},
"metadata": {
"og:title": "VibeTunnel Documentation",
"og:description": "Access your terminal sessions through any web browser",
"og:image": "/docs/images/vibetunnel-logo-light.svg"
},
"seo": {
"indexing": "all"
},
"search": {
"prompt": "Search VibeTunnel docs...",
"placeholder": "Search documentation"
}
}