32c689dfc5cef1233e3e99dd39137fd3d0904051
7 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
Britannio Jarrett
|
ddb21f969d |
update github docs (vibe-kanban) (#1388)
* 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. |
||
|
Britannio Jarrett
|
c4f4bf8318 |
I've updated the documentation image as requested. (#1390)
Here's what I did: 1. Copied the new image from `vk-task-dialog.png` to `docs/images/vk-task-dialog.png`. 2. Updated `docs/core-features/creating-tasks.mdx` to reference the new image. 3. Removed the old `docs/images/screenshot-create-task.png` file. The documentation now uses the new task dialog image. |
||
|
Britannio Jarrett
|
8579029a2e |
docs: task tags (vibe-kanban) (#1204)
* Done! Created [creating-task-tags.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/configuration-customisation/creating-task-tags.mdx) and updated [docs.json](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/docs.json). ## Required Image Updates The old template screenshots need to be replaced with new task tag screenshots: **Replace:** 1. `screenshot-global-task-templates.png` → `screenshot-task-tags-manager.png` (Settings → General → Task Tags table view) 2. `screenshot-project-task-templates.png` → Delete (project-specific tags no longer exist) 3. `screenshot-create-task-template-dropdown.png` → Split into: - `screenshot-create-task-tag.png` (tag creation dialogue) - `screenshot-task-tag-autocomplete.png` (@mention dropdown in task description) * Updated! The documentation now mentions that task tags work in both task descriptions and follow-up messages. * Copied to [screenshot-task-tags-manager.png](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/images/screenshot-task-tags-manager.png)! Still need: - `screenshot-create-task-tag.png` (tag creation dialogue) - `screenshot-task-tag-autocomplete.png` (@mention dropdown) * Perfect! All three screenshots are now in place: - [screenshot-task-tags-manager.png](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/images/screenshot-task-tags-manager.png) - [screenshot-create-task-tag.png](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/images/screenshot-create-task-tag.png) - [screenshot-task-tag-autocomplete.png](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/images/screenshot-task-tag-autocomplete.png) The old template images can now be deleted if desired. * All done! Updated all references: - [creating-tasks.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/core-features/creating-tasks.mdx) - Changed "Using Templates" to "Using Task Tags" with updated workflow - [global-settings.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/configuration-customisation/global-settings.mdx) - Updated section to "Task Tags" with new link - [creating-projects.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/ced3-docs-task-tags/docs/core-features/creating-projects.mdx) - Removed project-specific template reference - Deleted old template documentation and images can stay for now until you verify the new screenshots work * Done! Deleted all old template screenshots. The documentation migration from task templates to task tags is now complete. |
||
|
Britannio Jarrett
|
f88daa4826 | update docs after overhauled front-end (#1079) | ||
|
Britannio Jarrett
|
8c6f7c6d30 |
update docs (preview mode, mcp start task tool, GitHub Copilot) (vibe-kanban) (#992)
* update cleanup script docs * Perfect! I've successfully created comprehensive documentation for the Preview Mode feature and updated the existing documentation. Here's what I've completed: ## New Documentation Created **[Preview Mode](/core-features/preview-mode)** - A complete guide covering: - Overview and key benefits - Prerequisites and setup requirements - Step-by-step setup instructions for the Web Companion - Usage instructions with toolbar controls - Component selection workflow - Comprehensive troubleshooting section - Advanced usage examples ## Updated Documentation **[Task Details Full Screen Mode](/core-features/task-details-full-screen)** - Enhanced with: - Added Preview tab to the right panel navigation - New Preview Tab section explaining embedded browser functionality - Cross-reference link to the detailed Preview Mode documentation - Updated related documentation links **[Navigation](/docs.json)** - Added the new preview-mode page to the Core Features section ## Key Features Documented The documentation covers all the preview mode capabilities you described: - **Initial setup** requirements and configuration - **Automatic URL detection** from development server logs - **Embedded browser** viewing within full screen mode - **Web Companion installation** for component selection - **Precise component selection** with Alt+click and context menus - **Seamless workflows** without leaving Vibe Kanban The documentation includes placeholder spaces for screenshots as requested, and follows the existing Mintlify documentation patterns with proper formatting, components, and cross-references. * I've successfully updated the [Vibe Kanban MCP Server documentation](/integrations/vibe-kanban-mcp-server) with comprehensive tool coverage: ## New Documentation Sections Added **Available MCP Tools** - Complete reference tables organized by category: - **Project Operations**: `list_projects` - **Task Management**: `list_tasks`, `create_task`, `get_task`, `update_task`, `delete_task` - **Task Execution**: `start_task_attempt` (new feature) **Supported Executors** - Full list of coding agents that can be used with `start_task_attempt` **Status Values** - Valid kebab-case status values for filtering and updates ## Enhanced Example Usage **Planning and Task Creation** - Shows how coding agents use the `create_task` tool **Starting Task Execution** - Demonstrates the new `start_task_attempt` feature with example JSON parameters **Complete Workflow Example** - End-to-end workflow from listing projects to starting task execution The documentation now provides a complete reference for all MCP tools, with the new `start_task_attempt` feature prominently highlighted and explained with practical examples. * Done! I've updated [supported-coding-agents.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/supported-coding-agents.mdx): 1. **Reordered**: Claude Code first, OpenAI Codex second, then Amp 2. **Renamed**: "Codex" → "OpenAI Codex" 3. **Renamed**: "SST OpenCode" → "OpenCode" * Done! Updated [vibe-kanban-mcp-server.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/integrations/vibe-kanban-mcp-server.mdx): 1. Added syntax note to Option 2: Manual Configuration 2. Removed type hints from all parameters in MCP tools table 3. Removed the Info callout about `start_task_attempt` being newly added * Done! Removed the Status Values section from [vibe-kanban-mcp-server.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/integrations/vibe-kanban-mcp-server.mdx). * Done! I've updated the terminology in [vibe-kanban-mcp-server.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/integrations/vibe-kanban-mcp-server.mdx): - Changed section heading from "Using MCP with Coding Agents" to "Using the MCP Server" - Replaced "your coding agent" with "your MCP client" in the workflow steps and examples - Kept references to "coding agents" only where appropriate (e.g., when referring to agents within Vibe Kanban, or the executor parameter for `start_task_attempt`) * fix docs (vibe-kanban a870f5a1) The server is live and the docs are accessible via the URL http://localhost:3000/core-features/preview-mode I'm seeing `🚧 A parsing error occured. Please contact the owner of this website.` on this preview mode page and it seemingly has something to do with the Steps component. Using the Chrome DevTools that you have access to, you should be able to launch the website and iteratively make changes until this error is no longer present and the preview mode documentation is displaying itself as intended. You can look at recent commits to understand what has been changed with this documentation. You also have access to the Mintlify tools in order to search the official Mintlify documentation in case you need to troubleshoot. * Done! I've updated the [preview-mode.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/core-features/preview-mode.mdx) with: 1. **Emphasized automatic installation** as the recommended approach with an Info callout 2. **Accurate setup steps** from the official README for Create React App, Next.js, and Vite 3. **Removed conditional rendering** (`process.env.NODE_ENV` checks) since tree-shaking handles this automatically 4. **Added note about tree-shaking** to clarify that the companion is automatically removed from production builds * Done! I've completed both tasks: 1. ✅ Copied the dev server screenshot to [docs/images/preview-mode-start-dev-server.png](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/images/preview-mode-start-dev-server.png) 2. ✅ Removed the "Advanced Usage" section from [preview-mode.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/core-features/preview-mode.mdx) * Done! I've completed all the image updates: 1. ✅ Replaced the dev server start image with the new screenshot 2. ✅ Added all preview mode screenshots: - `preview-mode-interface.png` - Preview tab with dev server on - `preview-mode-component-selection.png` - Hovering over component with companion - `preview-mode-component-depth.png` - Component selected showing hierarchy 3. ✅ Removed all placeholder comments from the Frame elements * Done! I've completed all 6 review fixes: 1. ✅ Copied dev script config screenshot 2. ✅ Added install companion button screenshot within the Info callout 3. ✅ Removed the false "Automatically switch to Preview tab when ready" line 4. ✅ Added preview toolbar screenshot 5. ✅ Removed "Stop Dev" from toolbar controls (it's not part of the toolbar) 6. ✅ Fixed component selection instructions - now correctly states to click the floating VK companion button in bottom-right corner, removed incorrect Alt+Click and Context Menu instructions * Done! I've simplified the troubleshooting section to only include the relevant tip about ensuring the development server prints the URL to stdout/stderr for automatic detection, along with the supported URL formats. Removed all the less relevant troubleshooting content. * Done! I've completed all 3 review fixes: 1. ✅ Removed emojis from toolbar controls (🔄, 📋, 🌐) 2. ✅ Replaced component depth image with new screenshot and moved the old one to the top as an overview image 3. ✅ Removed "IDE" from the overview text - now only mentions switching between browser and Vibe Kanban * Done! Replaced the overview image with the new screenshot. * Done! I've fixed both issues in [task-details-full-screen.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/core-features/task-details-full-screen.mdx): 1. ✅ Updated toolbar description from "Start, stop, and manage your development server" to "Refresh the preview, copy the URL, or open in a new browser tab" 2. ✅ Changed image from `vk-preview.png` to `preview-mode-overview.png` (same as the preview mode docs page) * Done! I've added GitHub Copilot to the [supported coding agents documentation](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/supported-coding-agents.mdx). The new section includes: - Installation instructions via npm (`npm install -g @github/copilot`) - Prerequisites (Copilot subscription, Node.js 22+, npm 10+) - Authentication instructions using the `/login` command - Link to official GitHub Copilot CLI documentation It's positioned between Amp and Cursor CLI in the list. * Done! Removed the placeholder comment from [preview-mode.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/core-features/preview-mode.mdx). * remove old preview * Done! I've updated [vibe-kanban-mcp-server.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/integrations/vibe-kanban-mcp-server.mdx) with both corrections: 1. ✅ Changed "Create a task in 'plan mode'" to mention creating a custom agent profile with a planning prompt, with a link to the Agent Configurations documentation 2. ✅ Changed "Generate Sub-Tasks" to "Generate Tasks" since the MCP server only generates tasks, not sub-tasks * Done! Removed the "Real-time preview" line from the key benefits section in [preview-mode.mdx](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/4d6d-update-docs/docs/core-features/preview-mode.mdx). * update docs on Codex w/ ChatGPT * update MCP server install command docs |
||
|
Britannio Jarrett
|
3a68435f2a |
add docs for resolving rebase conflicts (vibe-kanban) (#778)
* Perfect! I've successfully created comprehensive documentation for conflict resolution in Vibe Kanban. Here's what I accomplished: ## Summary ✅ **Created a comprehensive documentation page** at [`docs/core-features/resolving-merge-conflicts.mdx`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/core-features/resolving-merge-conflicts.mdx) that covers: - **Git worktrees and branching concepts** with clear explanations - **Step-by-step rebase process** from detection to resolution - **Two resolution methods**: manual editing and automatic agent-based resolution - **Best practices** for preventing and handling conflicts - **Troubleshooting section** for common issues ✅ **Added Mermaid diagrams** to visualize: - How worktrees isolate different task attempts - The sequence of events that leads to conflicts ✅ **Included strategic placeholder content** for screenshots: - Rebase button interface - Rebase dialog - Conflict banner with options - Generated instructions interface ✅ **Updated navigation** in [`docs.json`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/docs.json) to include the new page in the Core Features section The documentation follows Mintlify technical writing standards and maintains consistency with existing documentation style, including proper use of components like Steps, Tabs, Accordions, and callout boxes. * Perfect! I've addressed all the review comments: ## Review Comments Resolved ✅ **Fixed Mermaid diagram syntax** - Changed from `<mermaid>` tags to code block syntax ```mermaid for both diagrams ✅ **Updated rebase button screenshot** - Copied and used the actual `vk-rebase-needed.png` image from Downloads ✅ **Enhanced conflict resolution section** - Added the `vk-rebase-conflicts-prompt-zoom.png` screenshot and improved the documentation to better describe: - The conflict resolution banner with three buttons (Open in Editor, Insert Resolve-Conflicts Instructions, Abort Rebase) - The state shown in the screenshot after pressing "Insert Resolve-Conflicts Instructions" - More detailed explanation of what users see in the interface The documentation now uses the actual screenshots from your Vibe Kanban application and follows proper Mintlify syntax conventions. The conflict resolution workflow is comprehensively documented with real visual examples that users will recognize when they encounter these situations. * Perfect! I've addressed both review comments: ## Review Comments Resolved ✅ **Fixed Mermaid diagram** - Removed the incorrect reference to creating a commit when creating the task branch. Now it accurately shows "Create task branch" instead of "Create branch (commit A)". ✅ **Simplified rebase process** - Updated the documentation to reflect the actual workflow: - The base branch is already set when creating the task - User simply clicks the **Rebase** button (no branch selection dialog) - Status changes from "Rebase needed" to either success or "Rebase conflicts" - Removed the incorrect rebase dialog screenshot reference - Added clear explanation of the status transitions The documentation now accurately reflects the streamlined rebase process in Vibe Kanban where users don't need to select branches during rebase - they just click the button and the system handles it based on the originally configured base branch. * Perfect! I've created a comprehensive state machine diagram that shows all the different states a task can be in and the transitions between them. Here's what I've accomplished: ## State Machine Diagram Features ✅ **Complete Task Lifecycle** - Shows the full journey from task creation to completion or cancellation ✅ **Detailed Conflict Resolution Flow** - Breaks down the conflict resolution process into granular states: - Conflict detection - Manual vs. automatic resolution options - Abort and retry paths - Final resolution to merge-ready state ✅ **Branch Status Integration** - Shows how branch status (up-to-date, behind, conflicts) affects the workflow ✅ **Color-Coded States** - Visual indicators for different types of states: - Green: Starting states - Yellow: Active/working states - Red: Conflict/error states - Blue: Success/ready states - Gray: End states ✅ **Clear Action Labels** - Each transition is labeled with the user action or system event that triggers it ✅ **Nested State Groups** - Complex states like "InProgress" and "InReview" are broken down into sub-states for clarity ## Key Benefits for Users This diagram helps users understand: 1. **Current Position** - Where they are in the task lifecycle 2. **Available Actions** - What they can do from their current state 3. **Path to Merge** - How to get from any state to a mergeable condition 4. **Conflict Resolution Options** - Clear paths for both manual and automatic conflict resolution 5. **Recovery Paths** - How to recover from errors or conflicts The state machine provides a complete mental model of the Vibe Kanban task workflow, making it easier for users to navigate complex scenarios like rebasing and conflict resolution. * Perfect! I've created a minimal, no-BS version at [`conflict-resolution-quick-guide.mdx`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/core-features/conflict-resolution-quick-guide.mdx) that covers only the essentials: ## Key Features of the Minimal Guide ✅ **Straight to the point** - Assumes user understands Vibe Kanban ✅ **Focused state diagram** - Only shows conflict resolution flow ✅ **Two clear options** - Manual vs automatic resolution ✅ **Essential steps only** - No explanatory text, just actions ✅ **Single screenshot** - The most important UI element ✅ **Quick reference format** - Scannable for users in a hurry ## What's Removed - Extensive explanations about Git worktrees - General Vibe Kanban concepts - Best practices section - Troubleshooting scenarios - Detailed background information - Multiple screenshots and examples ## What's Kept - Essential conflict resolution workflow - Clear action steps - The key screenshot showing the conflict banner - Simple state diagram focused only on conflict states - Immediate next steps This version is perfect for users who encounter their first merge conflict and just need to know "what do I click to fix this?" without all the context and background information. * ✅ Updated [`docs.json`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/docs.json) to include the new conflict resolution quick guide in the Core Features navigation. The documentation now has both versions: 1. **Comprehensive guide** - "Resolving Merge Conflicts" with full explanations 2. **Quick reference** - "Conflicts Quick Guide" for experienced users who just need the essentials * Perfect! I've successfully: ✅ **Removed the quick guide** - Deleted the file and updated [`docs.json`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/docs.json) ✅ **Simplified the state machine** - Reduced to just three core states: - **Mergeable** (green) - Ready to merge - **Behind** (yellow) - Needs rebase - **Rebase Conflicts** (red) - Conflicts to resolve The new diagram is much cleaner and focuses only on the branch status states that users actually encounter when dealing with merge conflicts. It shows the essential flow: task completes → base advances → rebase needed → conflicts (maybe) → back to mergeable. * ✅ **Removed the state machine entirely** from the documentation. The documentation now flows directly from the introduction to the Git worktrees explanation, making it more streamlined and focused on the practical aspects of resolving merge conflicts. * Perfect! I've completely restructured the documentation to be much more concise and focused: ## Key Changes Made ✅ **Moved rebase image to the top** - Now leads with "When You See 'Rebase Needed'" showing the actual UI ✅ **Simplified flow** - Clear progression: Rebase Needed → Click Rebase → Conflicts (maybe) → Resolution ✅ **Focused on automatic resolution** - Positioned as the "Recommended Approach" with the conflict resolution screenshot prominently displayed ✅ **Removed verbose sections**: - Git worktrees explanations - Complex state diagrams - Conflict types breakdown - Best practices section - Troubleshooting section ✅ **Made it more actionable** - Users see exactly what buttons to click and what happens next ## New Structure 1. **Rebase Needed** - Shows the rebase button image upfront 2. **What Happens** - Simple tabs showing success vs conflicts 3. **Automatic Resolution** - Featured approach with the conflict banner image 4. **Manual Alternative** - Brief alternative for advanced users 5. **Abort Option** - Simple escape hatch The documentation is now much more direct and focused on the essential user journey: see rebase button → click it → handle conflicts (preferably automatically) → done. * Perfect! I've addressed the review comment and made the requested improvements: ## Changes Made ✅ **Updated starting image** - Now shows the "Rebase conflicts" status instead of "Rebase needed" using the new screenshot ✅ **Restructured from conflicts state** - Docs now start after the user has already pressed rebase and encountered conflicts, which is more intuitive ✅ **Simplified automatic resolution section** - Converted the Steps component to a single, more concise paragraph that flows better ✅ **Streamlined flow** - Removed the "What Happens When You Rebase" section since we now start from the conflicts state ## New Structure 1. **When You See "Rebase Conflicts"** - Shows the actual conflict state with the new image 2. **Resolving Conflicts Automatically** - Single paragraph explaining the recommended approach 3. **Manual Resolution (Alternative)** - Brief alternative for advanced users 4. **Aborting a Rebase** - Simple escape hatch The documentation is now even more focused and starts exactly where users are most likely to be when they need help - after they've encountered conflicts and are looking at the conflict resolution banner. * ✅ **Added the conflict banner image** perfectly positioned after "The conflict banner provides three options to resolve the situation:" The documentation now has a clear visual showing exactly what the conflict banner looks like, making it much easier for users to identify the three options (Open in Editor, Insert Resolve-Conflicts Instructions, Abort Rebase) when they encounter the conflict state. This visual reinforcement helps users quickly understand their available actions. * ✅ **Updated the manual resolution section** to accurately reflect both approaches: ## Key Changes Made **Added two distinct options:** - **Single file approach** - Using "Open in Editor" from the conflict banner (requires refreshing and repeating for each file) - **Multiple files approach** - Using "Open in [Your IDE]" from the Actions pane (recommended for multiple conflicts) **Updated the workflow:** - Changed the first step to mention both options with a recommendation for the IDE approach - Updated the git commands to use `git add .` instead of adding individual files, since users would likely be resolving multiple files - Made it clear that the IDE approach is more efficient when dealing with multiple conflicted files This gives users a much clearer understanding of their options and steers them toward the more efficient workflow when they have multiple conflicts to resolve. * ✅ **Updated the automatic resolution text** with the requested changes: ## Changes Made - **Simplified description** - Changed from detailed list of actions to simply "complete the rebase automatically" - **British spelling** - Changed "analyze" to "analyse" - **Removed bold formatting** - Changed "**Send**" to just "Send" The text is now more concise and focuses on the end result rather than the technical details of what the agent does internally. * ✅ **Made "Send" bold again** - Changed back to **Send** to maintain consistency with other UI button references in the documentation. * ✅ **Updated the status description** to accurately reflect what users actually see - the task will show commits ahead (like "3 commits ahead") and the **Merge** button becomes available, rather than referring to a non-existent "Ready to Merge" status. * ✅ **Addressed both review comments:** ## Changes Made 1. **Fixed commits ahead text** - Changed "commits ahead" to "*n* commits ahead" with *n* in italics to show it's a variable number 2. **Converted to ordered list** - Broke down the wall of text into a clear 2-step ordered list: - Step 1: Click the button to generate instructions - Step 2: Review and send to the agent The automatic resolution section is now much more scannable and easier to follow, while the status description is more accurate about what users will actually see. * ✅ **Successfully updated the task-details-full-screen.mdx file** with all requested changes: ## Updates Made ✅ **Added backlink** - Added "Resolving Merge Conflicts" to both the Rebase section and Related Documentation section ✅ **Removed false statements**: - Removed "Some task actions (like "View full diff") automatically switch to full screen mode for better visibility" - Removed "Tab Navigation: Use browser tab controls to switch between Logs, Diffs, and Processes" - Removed "Conflict Handling: Any merge conflicts are displayed in the Diffs tab" ✅ **Added 'n' shortcut** - Added "**n**: Create a new task attempt" to the Keyboard Shortcuts section ✅ **Fixed British spelling** - Changed "Minimize" to "Minimise" in the Exiting Full Screen Mode section ✅ **Enhanced rebase section** - Added a proper reference to the new merge conflicts documentation right in the rebase section where users would need it most The documentation now accurately reflects the actual functionality and provides proper cross-references to help users navigate between related features. * ✅ **Successfully renamed the documentation from "Resolving Merge Conflicts" to "Resolving Rebase Conflicts"** ## Changes Made ✅ **Renamed file** - [`resolving-merge-conflicts.mdx`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/core-features/resolving-merge-conflicts.mdx) → [`resolving-rebase-conflicts.mdx`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/core-features/resolving-rebase-conflicts.mdx) ✅ **Updated frontmatter** - Changed title and sidebarTitle to "Resolving Rebase Conflicts" ✅ **Updated navigation** - Updated [`docs.json`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/docs.json) to reference the new file path ✅ **Updated cross-references** - Updated both references in [`task-details-full-screen.mdx`](file:///private/var/folders/5q/5vgq75y92dz0k7n62z93299r0000gn/T/vibe-kanban/worktrees/vk-2c23-docs-confl/docs/core-features/task-details-full-screen.mdx) to point to the renamed page The rename makes the documentation more accurate since these conflicts specifically occur during rebase operations in Vibe Kanban's workflow, not general merge operations. * ✅ **Image cleanup completed!** ## Summary **Images currently used in the documentation:** 1. ✅ `vk-rebase-conflicts-actions-pane.png` - Main image showing "Rebase conflicts" status 2. ✅ `vk-rebase-conflicts-banner.png` - Conflict banner showing three resolution options 3. ✅ `vk-rebase-conflicts-prompt-zoom.png` - Generated instructions in the follow-up field **Removed unused image:** - ❌ `vk-rebase-needed.png` - This was replaced when we restructured to start from the conflicts state instead of the "rebase needed" state All remaining images are actively referenced in the documentation and serve important purposes in explaining the conflict resolution workflow. |
||
|
Britannio Jarrett
|
09d2710a34 |
Update all documentation (#718)
* add AGENTS/CLAUDE.md file to docs/
* collapse supported coding agents (vibe-kanban 52fd2ae6)
docs/AGENTS.md
docs/docs.json
We have a section in the docs denoted 'Supported Coding Agents' but we don't need a separate sub page for each one, we can combine it into a single page.
* docs multiple dev servers (vibe-kanban 3e3a6195)
"At the moment only one dev server can be running for each project, so if you start one it will kill any that are already running."
This sentence in the docs is no longer true and should be removed
* docs update: reviewing code changes (vibe-kanban e3b5db87)
docs/AGENTS.md
docs/docs.json
Introduce a new page in the user guide that covers code review. After a task has completed, it will enter the 'in review' column. From there, the user can open the task in full screen and press on the 'Diff' tab to see each changed file in split or unified view. We also support attaching a review comment to a line by clicking on the plus icon at the start of the line. You can create several comments across files and even extend the review with general comments in the task chat field before submitting the review. It is turned into a single message for the coding agent to address.
* Document VS Code Extension Features (vibe-kanban e88b4bb9)
Create a comprehensive user guide page documenting the VS Code extension integration. It works with VSCode and forks of VSCode such as Cursor, Windsurf.
The IDE extension embeds the Logs, Diffs. and Processes view for a current task. It also has a text box to create new task attempts. After installing the extension, the easiest way to use it is by starting a task, opening it, in full screen mode, then pressing the 'Open in (VSCode/Cursor/Windsurf)' button. For troubleshooting, if you open your IDE but not in one of the worktrees created by a vibe kanban task, the extension UI will be empty because it won't find the associated task.
VSCode install link: https://marketplace.visualstudio.com/items?itemName=bloop.vibe-kanban
Cursor/Windsurf: https://open-vsx.org/extension/bloop/vibe-kanban
Id: bloop.vibe-kanban, users can search @id:bloop.vibe-kanban in any of the IDEs to find the extension. It's easiest to search the id if using Cursor/Windsurf as deeplinking from open vsx doesn't work.
* remove /docs prefix from internal links
* hackathon docs banner (vibe-kanban ce53b989)
<guide>
# Banner
> Add a banner to display important site-wide announcements and notifications
Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and can be made dismissible.
To add a banner, use the `banner` property in your `docs.json`:
<CodeGroup>
```json Product announcements wrap
"banner": {
"content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",
"dismissible": true
}
```
```json Maintenance notices wrap
"banner": {
"content": "⚠️ Scheduled maintenance: API will be unavailable December 15, 2-4 AM UTC",
"dismissible": false
}
```
```json Required actions wrap
"banner": {
"content": "**Action required:** Migrate to our new version by January 1. [Migration guide](/migration)",
"dismissible": true
}
```
</CodeGroup>
## Properties
<ResponseField name="content" type="string" required>
The banner message. Supports plain text and Markdown formatting.
</ResponseField>
<ResponseField name="dismissible" type="boolean">
Whether users can dismiss the banner. When `true`, users can close the banner and it won't reappear for their session. Defaults to `false`.
</ResponseField>
</guide>
We are hosting a hackathon in London on the 20th of September, so create a site-wide banner advertising this.
* update mcp server docs (vibe-kanban 94754ae1)
Update the documentation on the MCP server.
We have an existing page describing how it works, but it needs a bit of clarification because MCP support comes in two forms for us. Firstly, you can configure the MCP servers accessible to the coding agents you use within our product. And secondly, our product itself exposes an MCP server for other MCP clients to connect to, such as Claude Desktop, Raycast, or a coding agent that you're using either within Vive Kanban or outside Vive Kanban.
Our MCP server is a local MCP server as opposed to a remote MCP server and this means you can connect to it through apps that you've installed on your computer but you can't connect to clients that expect a publicly accessible URL.
The vibe-kanban-mcp-server docs page is exclusively focused on the MCP server that we expose but we should clarify this for users. This means we'll need a new page that focuses on the MCP Server configuration page that we have inside the app. And this is the page that lets users choose the MCP servers connected to each of the coding agents supported within Vibe Kanban. We also have a one-click installation feature for popular servers. such as, these are Context7 and Playwright.
# Update Media
Replace the main screenshot with /Users/britannio/Downloads/vk-mcp-server-config.jpeg by copying it into the project. This screenshot is taken from the MCP server's settings page and it's useful to show how we can add the Vibe Kanban MCP server to a coding agent that we're using within Vibe Kanban. We will also use this screenshot on the new page we're creating to show MCP server configuration, just to convey that you can bring your own MCP server or use one of our one-click installation popular servers for your coding agents.
/Users/britannio/Downloads/vk-raycast-mcp-part-2.png /Users/britannio/Downloads/vk-raycast-mcp-part-1.png
These screenshots are screenshots of the macOS Raycast app and they show you how you can configure the MCP server with it. Raycast is a popular MCP client just like Claude Desktop but many others are supported too.
* docs: creating task attempts - mintlify rules (vibe-kanban 2b54caea)
docs/user-guide/creating-task-attempts.mdx
Apply the Mintlify technical writing rules to this page.
* use british english in mintlify technical writing rule
* docs: agent configurations - mintlify rules (vibe-kanban 8e7d82ec)
docs/user-guide/agent-configurations.mdx
Apply the Mintlify technical writing rules to this page
* docs: creating projects (vibe-kanban 95cd181a)
docs/user-guide/creating-projects.mdx
Copy /Users/britannio/Downloads/vk-create-project.jpeg and use it as the screenshot
When the Create Project button is pressed, you have two options, either to create from an existing git repository or to create from a blank project. If you choose the former, then we will search your file system and show you a sorted list of git repositories that we find where the top project is the one that was most recently active.
In project settings, we not only let you control setup scripts, dev server scripts, and cleanup scripts, but we also let you specify a comma separated list of 'copy files'. And these are files like environment variables or other data that isn't tracked by git that you want to be present in the work tree created by every new task. Put this 'Copy Files' section above cleanup scripts.
How the codebase describes copy files: "Comma-separated list of files to copy from the original project directory to the worktree. These files will be copied after the worktree is created but before the setup script runs. Useful for environment-specific files like .env, configuration files, and local settings. Make sure these are gitignored or they could get committed!"
Since this page was created, we've changed the setup flow. So instead of configuring project settings during project creation, it's done afterwards. So once a user has created a project, they need to explicitly press the settings button in the top right to configure these scripts. As a result of this, it would be sensible to move all of the sections on project settings (git, setup scripts, etc) into a heading titled project settings.
From these project settings, you can also configure project task templates and we have more details about this in a subsection of a different page here: /user-guide/creating-task-templates#project-task-templates
* docs: getting started - minitlify (vibe-kanban 37318053)
{
"group": "Getting started",
"pages": ["index", "getting-started", "onboarding", "global-settings"]
},
Apply the Mintlify technical writing rules to these pages.
Additionally:
```
---
title: ""
description: ""
sidebarTitle: ""
---
```
These docs pages should have a title and description by including this block at the very top of the mdx file.
If the `title` attribute is equivalent to the first header, the header is redundant and can be removed.
sidebarTitle is optional and can be used if the main title os too verbose. The sidebar title should typically be two to three words.
* update creating projects text
* docs: creating tasks - mintlify (vibe-kanban a274f135)
docs/user-guide/creating-tasks.mdx
Apply the Mintlify technical writing rules to this page
* docs: creating task templates - mintlify (vibe-kanban 90f075a7)
docs/user-guide/creating-task-templates.mdx
Apply the Mintlify technical writing rules to this page
* update page title
* docs: keyboard shortcuts (vibe-kanban 8f39c2d0)
use the oracle to explore the codebase and learn how this feature works
add a new docs page covering each shortcut of significance (e.g. esc isn't significant)
* docs: task full screen mode (vibe-kanban a7e097dc)
Task details full screen mode: dev server, rebase, merge, subtask, new attempt, logs, diffs, processes.
Create a new docs page for this full scree mode explaining everything that can be done. Link to other docs for depth on each feature where appropriate.
use the oracle to explore the codebase and learn how this feature works
* docs: github features (vibe-kanban 29aa8f79)
add a docs page describing the features enabled by connecting to Github. Determine which screenshots will be needed and use placeholders for them until I give them to you.
use the oracle to explore the codebase and learn how this feature works
* docs: subtasks (vibe-kanban e038c1ad)
create a docs page for the subtask feature. Leave placeholders for screenshots: we need one for the full screen task view where you can see the button, one for viewing a task with subtasks, and one for viewing a subtask in full screen where it shows its parent task.
use the oracle to explore the codebase and learn how this feature works
* update subtask title
* docs: task templates (vibe-kanban 690b1933)
/Users/britannio/Downloads/vk-task-templates.png
/Users/britannio/Downloads/vk-proj-task-templates.png
Use these updated images in docs/user-guide/creating-task-templates.mdx
* docs: creating tasks screenshots (vibe-kanban 20f70e4f)
docs/user-guide/creating-tasks.mdx
/Users/britannio/Downloads/vk-create-task.png /Users/britannio/Downloads/vk-starting-task-attempt.png /Users/britannio/Downloads/vk-task-template.png
use these as the new screenshots
* docs: onboarding (vibe-kanban 631427c5)
docs/getting-started.mdx
docs/onboarding.mdx
In the documentation, we have an installation page and an onboarding page. But the onboarding page is a bit misleading because what actually happens when you set up the project and run the npx command for the first time is it will open the app and you'll see the projects page. There won't be any projects, so you'll have the chance to create your first project and create your first task. And then if you want to connect to GitHub, you have to manually go to settings and connect that. There isn't actually any encouragement for the user to do any of this. So, review those two pages and review the code base to double check that my understanding of the current onboarding flow is correct. And then update the documentation accordingly. We may not need the onboarding page at all if it's not relevant.
* docs: creating tasks (vibe-kanban 0eb62591)
docs/user-guide/creating-tasks.mdx
We should mention that tasks can be created by a coding agent or by an MCP client such as Claude Desktop or Raycast and then linked to the Vibe Kanban MCP server documentation. This isn't the expected use case for creating tasks but it can be useful for creating tasks in bulk based on existing data that you have or migrating tasks from a different system such as Linear, Github Issues
Conform to the mintlify technical writing rules.
* docs: settings (vibe-kanban 579e1663)
docs/global-settings.mdx
Use this screenshot instaed of screenshot-global-settings.png: /Users/britannio/Downloads/vk-settings.png
Don't change anything else.
* update creating tasks docs (vibe-kanban 140820a6)
docs/user-guide/creating-tasks.mdx
"After creating a project, add tasks by clicking the Add Task button in the navigation section of your project kanban page. Creating a task adds it to your kanban board without automatically starting a coding agent."
The button isn't an 'add task' button, it's a plus icon in the top right. You can also use the shortcut `c`.
* docs: creating task attempts (vibe-kanban fb8c5ad4)
docs/user-guide/creating-task-attempts.mdx
Review what is described in this documentation versus how it actually works in the frontend. For example, the previous documentation about the task attempt toolbar actions doesn't appear to hold anymore because the UI has changed. And the buttons in the image that it refers to are now only visible when viewing a task in full screen. And we have documentation on full screen mode. So that's an opportunity to backlink.
* update docs agents.md file
* Review and Harmonise All Documentation (vibe-kanban 7194a113)
Comprehensive review of all documentation pages to ensure:
- Consistent flow and navigation between pages
- Elimination of unnecessary information duplication
- Proper cross-referencing between related topics
- Consistent terminology and style
- Logical information architecture
- Updated navigation and table of contents
- Ensure docs conform to the mintlify technical rules, lean towards making smaller tweaks rather than larger rewrites as the content is already in a good state.
Deliverables:
- Updated navigation structure in docs.json
- Revised cross-references between pages
- Consolidated duplicate information
- Style and terminology consistency report
- Updated index and getting started pages to reflect new content
Location: Review all files in `/docs/` directory
* update image (vibe-kanban d0dcf34d)
docs/user-guide/creating-projects.mdx
/Users/britannio/Downloads/vk-create-proj.png
This is the new screenshot to use for the creating projects documentation. Just copy it and delete the old one.
* docs: delete unused images (vibe-kanban b8fdd325)
Find all unused images in the docs folder and remove them.
* remove review report
* move docs around (vibe-kanban 5ca2e108)
In the docs folder, we have a single subfolder called User Guide. But if you read docs.json, you'll see we now have four different sections of the documentation. I think the first section, being Getting Started, doesn't need its own folder, so the docs inside it can remain top level. But for all of the other sections, they should have their own folder named appropriately.
* update mintlify docs
* rename settings
* bring back ccr images (vibe-kanban 82c0f5d7)
Commit
|