Skip to content

docs: add an unlisted GoModel Pro page - #600

Merged
SantiagoDePolonia merged 1 commit into
mainfrom
docs/pro-page
Jul 27, 2026
Merged

docs: add an unlisted GoModel Pro page#600
SantiagoDePolonia merged 1 commit into
mainfrom
docs/pro-page

Conversation

@SantiagoDePolonia

@SantiagoDePolonia SantiagoDePolonia commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

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.json navigation. Mintlify builds and serves every .mdx under docs/, so the page is reachable at /pro without appearing in the sidebar or in any nav group. docs.json is untouched by this PR.

Contents

  • What Pro is — same gateway, one binary, licensed features; unlicensed builds run as plain open-source core and never block traffic
  • Token compression — the normalization pass and the deduplication pass, in plain terms, with the measured -19.4% corpus figure
  • What it never touches — tool-call arguments, first occurrences, sub-threshold requests; pure function of the body, fails open
  • Turn it off — the four levels: X-GoModel-Compression: off header, PRO_COMPRESSION_EXCLUDE_MODELS globs, PRO_COMPRESSION_ENABLED=false, or a license without the compression feature
  • Main settings — seven env vars, not the full seventeen
  • Seeing what it did — response headers, the audit revision chain, Prometheus counters and the dashboard Usage cards

Kept 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: true is 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 validate passes (runs in pre-commit)
  • docs.json unmodified — confirmed with git diff --stat docs/docs.json
  • Verify after deploy: /pro renders, and the page appears in no sidebar group

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added documentation for GoModel Pro and its licensed token compression feature.
    • Explained compression behavior, supported endpoints, error handling, and ways to disable it.
    • Documented configuration options, request-level controls, audit trails, response headers, and monitoring metrics.
    • Added guidance for limiting rewriting to newly added messages.

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>
Copilot AI review requested due to automatic review settings July 27, 2026 14:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@mintlify

mintlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gomodel 🟢 Ready View Preview Jul 27, 2026, 2:40 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds docs/pro.mdx, documenting GoModel Pro and its token compression feature, including rewrite behavior, configuration, disablement options, licensing, and observability.

Changes

GoModel Pro documentation

Layer / File(s) Summary
Compression overview
docs/pro.mdx
Adds Pro page metadata, licensing context, and token compression behavior, including normalization, deduplication, unchanged request areas, determinism, and fail-open handling.
Compression controls and observability
docs/pro.mdx
Documents disablement levels, rewrite scope, environment settings, response headers, audit chains, and aggregate metrics.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: copilot

Poem

I’m a rabbit with docs to share,
Compression hops through token air.
Settings guide each graceful turn,
Metrics show the savings earned.
Pro pages bloom—now readers learn!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately describes the main change: adding an unlisted GoModel Pro docs page.
Description check ✅ Passed The description covers what changed, why, key behavior, test plan, and AI-generated notes, so it is mostly complete despite different headings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/pro-page

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a7b4c0 and ceda49e.

📒 Files selected for processing (1)
  • docs/pro.mdx

Comment thread docs/pro.mdx
Comment on lines +123 to +125
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ 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

@SantiagoDePolonia
SantiagoDePolonia merged commit 12f46a2 into main Jul 27, 2026
21 checks passed
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@greptile-apps

greptile-apps Bot commented Jul 27, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

The 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.

T-Rex T-Rex Logs

What T-Rex did

  • The team ran Playwright Chromium end-to-end checks to compare the local Mintlify site before and after the change using recordings and screenshots.
  • Navigation evidence was inspected, confirming the provider sidebar rendered and visibleExactProNavigationLinks is an empty set.
  • Validation and configuration checks completed successfully.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs: add an unlisted GoModel Pro page" | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants