Collaboration Concept & Uniform Casing#384
Conversation
✅ Deploy Preview for caido-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds a new concept page describing collaboration approaches in Caido (closing #369) and standardizes heading/title casing across several existing documentation pages.
Changes:
- Add a new Collaboration concept page describing shared-instance vs Drop-based collaboration.
- Add the new concept page to the app concepts sidebar.
- Normalize heading casing across multiple Dashboard, App, and Burp Suite mapping docs.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/dashboard/guides/education_plan.md | Standardizes page/section heading casing for the Education plan guide. |
| src/burp-suite/extensibility/custom-scan-checks.md | Normalizes a section heading’s casing. |
| src/burp-suite/core/tools.md | Normalizes multiple feature heading casings. |
| src/burp-suite/core/target-and-scope.md | Normalizes multiple feature heading casings. |
| src/burp-suite/core/scans.md | Normalizes multiple feature heading casings. |
| src/burp-suite/core/reporting.md | Normalizes a section heading’s casing. |
| src/burp-suite/core/project-and-configuration.md | Normalizes multiple feature heading casings. |
| src/burp-suite/core/overview.md | Normalizes heading casing and slightly adjusts wording/casing in the “How to use” section. |
| src/burp-suite/core/browser-and-setup.md | Normalizes multiple feature heading casings. |
| src/burp-suite/core/ai.md | Normalizes multiple feature heading casings. |
| src/app/quickstart/plugins.md | Minor grammar tweak (“a high degree of customization”). |
| src/app/concepts/pat.md | Normalizes concept section heading casing. |
| src/app/concepts/instance.md | Minor emphasis/casing adjustments (e.g., “instance”, “Caido CLI”). |
| src/app/concepts/instance_registration.md | Normalizes heading casing and “Caido CLI” casing. |
| src/app/concepts/instance_authentication.md | Normalizes section heading casing. |
| src/app/concepts/collaboration.md | Adds the new collaboration concept content. |
| src/app/concepts/cloud.md | Normalizes a section heading’s casing. |
| .vitepress/sidebars/app/concepts.ts | Adds the new Collaboration concept page to the sidebar. |
There was a problem hiding this comment.
There's an important part missing from the original issue:
They should then be directed to the right place to implement the collaboration method.
Can we add links in the concept page directing users to the right guides/tutorials depending on the type of collaboration they want?
Edit: Ah, I see they are at the top.
Links should be closer to where they are expected to be clicked. If I visit collaboration for the first time, I won't click on the links without first understanding what they are.
I'd move those links under each section.
Closes #369