5805ab9fc92ea1443e8d4d8a7ed934e47fdb8bb9
4 Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
Britannio Jarrett
|
f88daa4826 | update docs after overhauled front-end (#1079) | ||
Alex Netsch
|
2dba0713c8 |
Simplify disclaimer (vibe-kanban) (#785)
* Perfect! I've successfully simplified the disclaimer dialog as requested. Here's what I've accomplished: 1. **Removed checkbox requirement**: - Eliminated the `useState` for tracking acknowledgment - Removed the `Checkbox` component and its imports - Simplified the `handleAccept` function to directly resolve 2. **Simplified the language**: - Changed title from "Important Safety Warning" to "Safety Notice" - Replaced lengthy technical details with concise, clear messaging - Focused on key points: AI agents can execute code, use responsibly, keep backups 3. **Added documentation link**: - Included a clickable link to `https://www.vibekanban.com/docs` - Styled the link with appropriate hover effects 4. **Updated button behavior**: - Removed the `disabled` state since no checkbox is required - Changed button variant from "destructive" to "default" (less alarming) - Updated button text to "I Understand, Continue" - **Rust linting**: ✅ All clippy checks passed - **Frontend formatting**: ✅ Prettier formatted the disclaimer dialog - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings, nothing related to my changes The disclaimer dialog is now much more user-friendly while still maintaining important safety messaging, with users directed to the full documentation for detailed information. Perfect! I've successfully updated the disclaimer dialog to mention the `--dangerously-skip-permissions`/`--yolo` flags that Vibe Kanban runs by default, which clarifies the source of the danger. **Updated the disclaimer dialog to:** 1. **Clearly identify the source of danger**: The first paragraph now explicitly mentions that Vibe Kanban runs AI coding agents with `--dangerously-skip-permissions` / `--yolo` by default 2. **Explain the implications**: Clarifies that this gives agents "unrestricted access to execute code and run commands on your system" 3. **Maintain other improvements**: Kept the simplified language, removed checkbox, and documentation link - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ Prettier formatted the updated disclaimer dialog - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings, nothing related to my changes The disclaimer now provides much clearer information about why the software is potentially dangerous - it's specifically because Vibe Kanban runs agents with flags that bypass safety permissions by default. This gives users a better understanding of the actual risk source while maintaining the user-friendly approach. Perfect! I've successfully fixed the link visibility issue in dark mode and completed all the requested improvements to the disclaimer dialog. **Disclaimer Dialog Improvements:** 1. **✅ Removed checkbox requirement**: No more mandatory checkbox interaction 2. **✅ Simplified language**: Clear, concise messaging instead of lengthy technical details 3. **✅ Added docs link**: Points users to https://www.vibekanban.com/docs for detailed information 4. **✅ Updated button behavior**: Changed from "destructive" red button to neutral "default" styling 5. **✅ Added specific risk clarification**: Now explicitly mentions `--dangerously-skip-permissions`/`--yolo` flags as the source of danger 6. **✅ Fixed dark mode visibility**: Link now uses `text-blue-600 dark:text-blue-400` for proper visibility in both light and dark themes - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted with Prettier - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes The disclaimer dialog is now much more user-friendly while clearly communicating the specific safety risks. Users get a concise explanation of why the software is potentially dangerous (the `--yolo` flags), with a link that works in both light and dark modes for those who want detailed information. Perfect! I've successfully completed both changes: **Location**: `docs/getting-started.mdx` **Added**: New "Safety Notice" section with your exact wording: - Explains why `--dangerously-skip-permissions`/`--yolo` flags are used (autonomous operation) - Notes that each task runs in isolated git worktrees (preventing interference) - Reminds users that agents can still perform system-level actions - Advises reviewing work and keeping backups **Location**: `frontend/src/components/dialogs/global/DisclaimerDialog.tsx` **Changed**: "For detailed information about risks and best practices, visit" → "Learn more at" **Reason**: More accurate since the docs don't contain comprehensive security information - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes The security messaging is now much more accurate and helpful. Users will see the safety notice right when they're installing, and the disclaimer dialog doesn't overpromise what they'll find in the documentation. Perfect! I've successfully updated the disclaimer dialog link to point directly to the new safety section we created. **Location**: `docs/getting-started.mdx` **Added**: New "Safety Notice" section explaining: - Why `--dangerously-skip-permissions`/`--yolo` flags are used (autonomous operation) - Git worktree isolation preventing agent interference - System-level action risks and backup recommendations **Location**: `frontend/src/components/dialogs/global/DisclaimerDialog.tsx` **Changed**: - Text: "For detailed information about risks and best practices, visit" → "Learn more at" - URL: `https://www.vibekanban.com/docs` → `https://www.vibekanban.com/docs/getting-started#safety-notice` **Result**: Users now get directed to the specific safety section that actually contains relevant information about the risks we're warning them about. - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 96 warnings (no errors) - all existing warnings unrelated to our changes Now when users see the disclaimer dialog and click "Learn more at", they'll be taken directly to the relevant safety information instead of just the general docs homepage. This creates a much better, more cohesive user experience! * Perfect! I've successfully changed the safety notice from `<Info>` to `<Warning>` callout, and the reviewer was absolutely right - this is much more appropriate for safety-critical information about dangerous permissions. ## ✅ Final Summary of All Changes ### Disclaimer Dialog Improvements: 1. **✅ Removed checkbox requirement**: No mandatory checkbox interaction 2. **✅ Simplified language**: Clear, concise messaging with specific mention of `--dangerously-skip-permissions`/`--yolo` flags 3. **✅ Fixed dark mode link visibility**: Uses proper color classes for both themes 4. **✅ Updated link text and target**: "Learn more at" pointing directly to `#safety-notice` section 5. **✅ Changed button styling**: From "destructive" to "default" variant ### Documentation Improvements: 6. **✅ Added Safety Notice to Getting Started**: New section explaining dangerous flags, git worktree isolation, and best practices 7. **✅ Used proper Warning callout**: Changed from `<Info>` to `<Warning>` as suggested by reviewer - much more appropriate for safety information ## ✅ Quality Checks Passed - **Rust linting**: ✅ All clippy checks passed - **Code formatting**: ✅ All code properly formatted - **Frontend linting**: ✅ 97 warnings (no errors) - all existing warnings unrelated to our changes The safety messaging is now complete and properly emphasizes the importance of the information with the `<Warning>` callout, while still being informative and not overly alarming. Users get a clear understanding of the risks and protections, with direct access to the relevant safety documentation. * Clippy |
||
|
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
|
||
|
Britannio Jarrett
|
3db315931b | introduce docs by powered by Mintlify (#679) |