docs: ShipVoice Lite rebrand and a Mintlify docs site - #5
Conversation
"ShipVoice" beside "ShipVoice Pro" read as one product and its upgrade. Lite beside Pro reads as a tier, which is what it is. The GitHub slug stays 'shipvoice', so every existing link and clone URL still resolves. The founder's canonical vision doc and the Pro repo's CLAUDE.md were updated first, per their own precedence. The docs site is nine pages on the Sequoia theme, in the console's own brand ramp, with two tabs. Lite carries Get started, Customize and Ship it; Pro is one page saying the Pro docs are not published yet, with the accurate summary of the line between the products until they are. It is deliberately small. Troubleshooting sits in Get started rather than at the end, because every failure in this stack is quiet: a mismatched agent name mints a valid token, opens a real room, and logs nothing. That page is the one people will need. Fixed before this shipped, from review: - index.mdx frontmatter was invalid YAML. An unquoted second colon in the description turns the scalar into a mapping, which fails the build. - deploy.mdx said CORS_ORIGINS_STR defaults to http://localhost:5173. Compose sets that; the code default is empty and BACKEND_CORS_ORIGINS returns ["*"] for empty, so a backend started without it accepts browser calls from anywhere. That correction is on the page telling people what to check before the backend faces a network, so it mattered. - Nothing on the site linked to the repository, so the quickstart began one step after a reader could follow it. The navbar carries it now. - docs/superpowers is gitignored, so a Git-based build never sees it, but the local CLI walks the whole content root and failed to parse the plan files as MDX. A .mintignore keeps them where they are. - The Pro tab was a stub whose only job was to link to a page sitting in the Lite tab. One page, in the tab it belongs to. - The prompt excerpt in persona.mdx dropped the Guardrails section. - A refused prompt save is 403 when writes are disabled and 409 when the mount is missing. The page called both 409. - The noise-cancellation snippet in providers.mdx was a NameError. - BUSINESS_NAME is reported with a call, not put in the prompt. - The worker no longer crash-loops on a missing LiveKit value; it exits and names the one that is missing. - README and AGENTS.md sent people to the Agents list for a control that is on the agent's own page. Known: Mintlify's a11y check fails colors.primary (#e5323f) at 4.32:1 on a light background against the 4.5:1 AA minimum. That is the console's brand red, kept deliberately. colors.dark (#b81f2b) passes at 6.42:1 and is what light mode uses for text, so the practical exposure is small.
|
Warning Review limit reached
Next review available in: 58 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
WalkthroughThe change rebrands the repository as ShipVoice Lite and adds a Mintlify documentation site. New guides cover setup, configuration, deployment, console mode, persona editing, provider changes, product scope, and troubleshooting. ChangesShipVoice Lite identity and onboarding
Documentation site and product scope
Setup and runtime guides
Diagnostics
Estimated code review effort: 3 (Moderate) | ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/docs.json`:
- Line 4: Update the site name value in the docs configuration to use the Lite
product name, “ShipVoice Lite,” so it matches the branding in docs/index.mdx.
In `@README.md`:
- Around line 118-119: Update the README manual test-call instructions to
include the complete button sequence, specifically the Test call action
documented in AGENTS.md and the Docker flow, using the same exact sequence
across all onboarding instructions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: ddb514b5-3a1e-4494-b1e9-604349e600e8
⛔ Files ignored due to path filters (1)
docs/favicon.svgis excluded by!**/*.svg
📒 Files selected for processing (15)
AGENTS.mdREADME.mdagent/README.mdbackend/README.mddocs/.mintignoredocs/configuration.mdxdocs/console-mode.mdxdocs/deploy.mdxdocs/docs.jsondocs/index.mdxdocs/persona.mdxdocs/pro.mdxdocs/providers.mdxdocs/quickstart.mdxdocs/troubleshooting.mdx
| { | ||
| "$schema": "https://mintlify.com/docs.json", | ||
| "theme": "sequoia", | ||
| "name": "ShipVoice", |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use the Lite product name in the site configuration.
Line 4 makes Mintlify render ShipVoice instead of ShipVoice Lite. This conflicts with the rebrand objective and docs/index.mdx.
Proposed fix
- "name": "ShipVoice",
+ "name": "ShipVoice Lite",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "name": "ShipVoice", | |
| "name": "ShipVoice Lite", |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/docs.json` at line 4, Update the site name value in the docs
configuration to use the Lite product name, “ShipVoice Lite,” so it matches the
branding in docs/index.mdx.
| Open `http://localhost:5173`, go to **Agents**, open the agent, start a test call, | ||
| allow the mic, and talk. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the complete manual test-call sequence.
The manual flow omits the Test call step documented in AGENTS.md and the Docker flow. Use the same exact button sequence in all onboarding instructions.
Proposed wording
-Open `http://localhost:5173`, go to **Agents**, open an agent, start a test call,
-allow the mic, and talk.
+Open `http://localhost:5173`, go to **Agents**, open the agent, select **Test call**,
+then select **Start test call**, allow the mic, and talk.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 118 - 119, Update the README manual test-call
instructions to include the complete button sequence, specifically the Test call
action documented in AGENTS.md and the Docker flow, using the same exact
sequence across all onboarding instructions.
…ding 'You edited the wrong .env' is the answer the reader came for, not what they observed. Nobody searches for a mistake they do not know they made. The heading is the symptom now and the cause is the first line under it. An earlier pass meant to fix this and silently missed: the exact-string replace did not account for the backticks around .env.
A public date is a promise that ages badly and has to be defended. The paid product is at shipvoice.dev either way, and the pages that named a day now say what is true without one.
1 participant
Two pieces of work.
1. Rebrand to ShipVoice Lite
ShipVoicebesideShipVoice Proread as one product and its upgrade. Lite beside Pro reads as a tier, which is what it is.The GitHub slug stays
shipvoice, so every existing link and clone URL still resolves. The founder's canonicalPRODUCT_VISION.mdand the Pro repo'sCLAUDE.mdwere updated first, per their own precedence rule.2. A Mintlify docs site at
docs/Nine pages on the Sequoia theme, in the console's own brand ramp (
#e5323f/#ff6f78/#b81f2b), two tabs:Deliberately small. Troubleshooting sits in Get started rather than at the end, because every failure in this stack is quiet and that page is the one people will need.
npx mint broken-linkspasses. The PyPI CLI is not documented yet, by request.Review found 14 issues, all fixed
Worth calling out three:
index.mdxfrontmatter was invalid YAML. An unquoted second colon in the description turns the scalar into a mapping, which fails the build.deploy.mdxhad the CORS default backwards. Compose setshttp://localhost:5173; the code default is empty andBACKEND_CORS_ORIGINSreturns["*"]for empty, so a backend started without it accepts browser calls from anywhere. That correction sits on the page telling people what to check before the backend faces a network.docs/superpowersbroke the local CLI. It is gitignored so a Git-based build never sees it, but the CLI walks the whole content root. A.mintignorekeeps the plan files where they are.Also: 403 vs 409 on a refused prompt save, a
NameErrorin the noise-cancellation snippet, a truncated prompt excerpt,BUSINESS_NAMEdescribed as reaching the model when it does not, and README/AGENTS.md sending people to the Agents list for a control that is on the agent's own page.Known
Mintlify's a11y check fails
colors.primaryat 4.32:1 on a light background against the 4.5:1 AA minimum. That is the brand red, kept deliberately.colors.darkpasses at 6.42:1 and is what light mode uses for text, so the practical exposure is small. One hex change fixes it if you want the pass.Summary by CodeRabbit