ddb21f969d
* I have explored the codebase and confirmed that the GitHub integration now relies on the `gh` CLI instead of a Personal Access Token (PAT) configured in the settings. The setup process is "just-in-time", prompting the user to install or authenticate the CLI when they attempt to create a Pull Request. I have updated the documentation to reflect these changes: 1. **`docs/integrations/github-integration.mdx`**: Rewrote the guide to explain the CLI-based workflow, including automatic setup on macOS and manual setup instructions for other platforms, as well as troubleshooting steps. 2. **`docs/getting-started.mdx`**: Updated the installation steps to remove the instruction to "Connect to GitHub in Settings" and instead mention the `gh` CLI requirement. 3. **`docs/configuration-customisation/global-settings.mdx`**: Removed the "GitHub Integration" section (since it no longer exists in Global Settings) and replaced it with a "Git Configuration" section describing the "Branch Prefix" setting, which is present in the UI. I also verified that `docs/core-features/completing-a-task.mdx` remains accurate with the new workflow. No images were needed as the process is now primarily CLI-driven or standard dialog-based, and I removed the outdated screenshots from the documentation files. I ran `pnpm run check` to ensure no regressions were introduced, and it passed successfully. ### Summary of Changes | File | Change | | :--- | :--- | | `docs/integrations/github-integration.mdx` | Rewritten to document `gh` CLI usage and troubleshooting | | `docs/getting-started.mdx` | Removed outdated "Connect GitHub" step; added CLI info | | `docs/configuration-customisation/global-settings.mdx` | Removed GitHub section; added Git Branch Prefix section | * The "Troubleshooting" section has been removed from `docs/integrations/github-integration.mdx`. * I have performed a comprehensive search for "github" across the documentation and codebase. I found and updated a few more references to ensure consistency: 1. **`docs/core-features/completing-a-task.mdx`**: Updated the link text to "Set up GitHub CLI integration" instead of "Set up GitHub authentication". 2. **`docs/index.mdx`**: Updated the Settings card description to remove "GitHub integration" and replace it with "git settings". 3. **`docs/configuration-customisation/global-settings.mdx`**: Updated the alt text of the settings screenshot to remove the mention of "GitHub integration settings". I verified other references in `docs/core-features/creating-tasks.mdx`, `docs/core-features/monitoring-task-execution.mdx`, and `docs/supported-coding-agents.mdx` and confirmed they are either correct (referring to platform features like polling or agents like Copilot) or generic examples that don't need changing. The documentation now fully reflects the shift to the CLI-based GitHub integration workflow.
43 lines
1.5 KiB
Plaintext
43 lines
1.5 KiB
Plaintext
---
|
|
title: "Vibe Kanban Documentation"
|
|
description: "Orchestrate AI coding agents with confidence. Plan, review, and manage AI-generated code in isolated git worktrees with complete control."
|
|
sidebarTitle: "Home"
|
|
---
|
|
|
|
## What is Vibe Kanban?
|
|
|
|
Vibe Kanban is an **orchestration platform for AI coding agents** that helps developers plan, review, and safely execute AI-assisted coding tasks. Each task runs in an isolated git worktree, giving you complete control over your codebase whilst leveraging the power of AI assistants.
|
|
|
|
<Frame>
|
|
<img src="/images/vibe-kanban-screenshot-overview.png" />
|
|
</Frame>
|
|
|
|
## Why Vibe Kanban?
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="Safe AI Execution" icon="shield-check">
|
|
Every task runs in an isolated git worktree. Agents can't interfere with each other or your main branch.
|
|
</Card>
|
|
|
|
<Card title="Multi-Agent Support" icon="users">
|
|
Switch between Claude Code, OpenAI Codex, Amp, Cursor Agent CLI, Gemini, and other agents without changing workflows.
|
|
</Card>
|
|
|
|
<Card title="Visual Code Review" icon="code-compare">
|
|
Review AI changes with line-by-line diffs, add comments, and send feedback back to the agent.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
|
|
## Need Help?
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="User Guide" icon="book" href="/core-features/creating-projects">
|
|
Complete guides for creating projects, tasks, and working with coding agents
|
|
</Card>
|
|
|
|
<Card title="Settings" icon="gear" href="/configuration-customisation/global-settings">
|
|
Configure themes, default agents, git settings, and more
|
|
</Card>
|
|
</CardGroup>
|