docs: add an unlisted GoModel Pro page - #600
Conversation
Covers what Pro is, the token-compression feature as it stands today, and the four ways to turn compression off (per-request header, model globs, master switch, license entitlement). Deliberately not added to docs.json navigation: Mintlify builds and serves every .mdx under docs/, so the page is reachable at /pro without appearing in the sidebar. Carries noindex so it stays out of search engines until it is linked; drop that frontmatter line to publish it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughAdds ChangesGoModel Pro documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/pro.mdx`:
- Around line 123-125: Update the audit entries description to remove the
unconditional claim that the full before/after bodies are always recoverable.
Explain that revision bodies are retained only when audit body logging is
enabled and the body is within the capture limit; otherwise, retain the
practical guarantee of metadata, sizes, and rewrite details alongside the
original request and revision chain.
🪄 Autofix (Beta)
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: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 244163ea-7a24-4883-ac93-597e96812353
📒 Files selected for processing (1)
docs/pro.mdx
| Audit entries keep the **original** client request plus a revision chain | ||
| showing exactly what each rewriter changed, so the full before/after is | ||
| always recoverable. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Do not promise universally recoverable before/after bodies.
Revision bodies are captured only when audit body logging is enabled and the body is within the capture limit; otherwise the revision retains metadata, sizes, and detail only. State those conditions instead of saying the full before/after is “always recoverable.” internal/auditlog/auditlog.go:192-222; internal/server/request_rewrite.go:127-148. As per coding guidelines, keep documentation practical and user-focused.
🤖 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/pro.mdx` around lines 123 - 125, Update the audit entries description to
remove the unconditional claim that the full before/after bodies are always
recoverable. Explain that revision bodies are retained only when audit body
logging is enabled and the body is within the capture limit; otherwise, retain
the practical guarantee of metadata, sizes, and rewrite details alongside the
original request and revision chain.
Source: Coding guidelines
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Confidence Score: 5/5The PR appears safe to merge with no actionable issues identified. The new page follows the repository’s documentation conventions, uses supported Mintlify components and frontmatter, and introduces no demonstrated build, rendering, navigation, or content-contract failure.
What T-Rex did
Reviews (1): Last reviewed commit: "docs: add an unlisted GoModel Pro page" | Re-trigger Greptile |
Summary
Adds
docs/pro.mdx— a single, deliberately short page covering what GoModel Pro is, the token-compression feature as it stands today, and how to turn compression off.Not added to
docs.jsonnavigation. Mintlify builds and serves every.mdxunderdocs/, so the page is reachable at/prowithout appearing in the sidebar or in any nav group.docs.jsonis untouched by this PR.Contents
-19.4%corpus figureX-GoModel-Compression: offheader,PRO_COMPRESSION_EXCLUDE_MODELSglobs,PRO_COMPRESSION_ENABLED=false, or a license without thecompressionfeatureKept intentionally lean: it is a landing page for someone evaluating or operating Pro, not a reference manual. The full env-var matrix lives in the pro repo's README.
Two decisions worth a second opinion
noindex: trueis set in the frontmatter, so the page stays out of search engines while it is unlinked. If the intent is for prospects to find it organically, delete that one line. Note that an unlinked page does still appear in the docs site's own search — hiding it from the sidebar is not the same as hiding it entirely.No pricing, no purchase link, no license-acquisition instructions. The page explains the feature and the config surface only. Add those when there is a URL to point at.
Test plan
mint validatepasses (runs in pre-commit)docs.jsonunmodified — confirmed withgit diff --stat docs/docs.json/prorenders, and the page appears in no sidebar group🤖 Generated with Claude Code
Summary by CodeRabbit