docs(platform): refresh manual guides and links - #14447
Conversation
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_d14e6563-6790-4592-ae76-c414716069f8) |
🔍 PR Overlap DetectionThis check compares your PR against all other open PRs targeting the same branch to detect potential merge conflicts early. 🔴 Merge Conflicts DetectedThe following PRs have been tested and will have merge conflicts if merged after this PR. Consider coordinating with the authors.
Summary: 3 conflict(s), 0 medium risk, 0 low risk (out of 3 PRs with file overlap) Auto-generated on push. Ignores: |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (4)
🔇 Additional comments (2)
WalkthroughDocumentation links and image paths were corrected. Provider model listings and Codex mappings were refreshed. The API guide now documents OAuth links and scopes. ChangesDocumentation updates
Priority: ⬇️ Low — Defer this documentation-only update because it refreshes links, model catalogs, integration guidance, and OAuth scope descriptions without changing product behavior. Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This update refreshes documentation links, assets, provider guidance, and OAuth scope descriptions. The documented navigation and integration guidance are consistent with their referenced guides, with no remaining merge-readiness risk identified. 🚥 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 |
|
/review |
|
🤖 Review of |
There was a problem hiding this comment.
✅ Verdict: Approved — No findings require changes before approval; this review counts as an approval.
Documentation-only refresh of six Markdown guides; all image paths, relative links, OAuth scopes, and model catalog IDs verified accurate against current dev source by every specialist. GitHub CI is green on head c3542d1 and there are no code, API, or schema changes. No blockers.
Risk level: low | Human review: not required | Duration: 420s | Reviewed: c3542d19
Findings: 🔴 0 blockers | 🟠 0 should fix | 🟡 1 nice to have | 🔵 1 nit
Optional advice — does not block approval
🟡 Nice to Have
- 🔵
docs/platform/codex-subscription-preview.mdConsider a table for the Codex tier mapping — The Balanced/Advanced tier-to-model routing prose is dense and harder to maintain over time.
Suggestion: Optionally restructure the tier mapping as a small two-row table.
Optional advice — does not block approval
🔵 Nits
- 🔵
docs/platform/integrating/api-guide.md:51Align WRITE_GRAPH description with enum semantics — WRITE_GRAPH is described as 'Create agent graphs', but the backend scope enum documents it as 'Can create and update agent graphs' (schema.prisma:2050), understating the permission.
Suggestion: Change the description to 'Create and update agent graphs'.
GitHub CI on reviewed head: success
Validation and specialist details
Specialist Reports
| Specialist | Status | Summary |
|---|---|---|
| security | ✅ PASS | Documentation-only refresh of links, image paths, model lists, and OAuth scope docs; all links/scopes verified against current source with no security impact. |
| architect | ✅ PASS | Documentation-only refresh with all image paths, links, OAuth scopes, and model IDs verified accurate against current dev source. |
| performance | ✅ PASS | Documentation-only Markdown changes (link repaths, model tables, OAuth scope docs) with no runtime, query, or scalability impact. |
| testing | ✅ PASS | Documentation-only PR; all relocated links, image paths, model IDs, and OAuth scopes verify against current dev source, with one cosmetic scope-description nit. |
| quality | ✅ PASS | Documentation-only refresh whose links, model tables, and OAuth scopes all verify correctly against the current dev source and LLM catalog. |
| product | ✅ PASS | Docs-only refresh; all image paths, links, OAuth scopes, and model catalogs verified accurate against current source with no user-facing defects. |
| discussion | ✅ PASS | All required CI checks pass on head c3542d1 with no base merge conflict, and there are no open change requests from human reviewers. |
| ui-reviewer (local) | ✅ PASS | Documentation-only PR; all image paths, relative links, OAuth scopes, and model IDs verified correct against current dev source with no defects introduced. |
| ui-reviewer (hosted) | ✅ PASS | Documentation-only refresh whose repaired links all resolve and whose scope, model-catalog, and Codex routing claims all match current source; no defect introduced. |
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_06b9d14b-9225-496c-8a2a-652e9e9b4b40) |
|
/reapprove |
gaoanze888
left a comment
There was a problem hiding this comment.
Verified the link fixes actually resolve — the part a bot can't easily check.
Verified (relative paths resolve in the repo):
../imgs/aimlapi/→../content/imgs/aimlapi/: all 12 referenced Step PNGs exist at the new path; the olddocs/imgs/dir is gone, so the old links were genuinely broken. ✅../imgs/ollama/→../content/imgs/ollama/: 9 images resolve at the new path. ✅content/index.mdlinks:[Build your own Blocks](../platform/new_blocks.md)→docs/platform/new_blocks.mdexists;[Contribute](contribute/index.md)→docs/content/contribute/index.mdexists. ✅gemini.mdis text-only (no image refs), so the emptydocs/content/imgs/gemini/dir is harmless — no broken links there. ✅
Content refreshes look right: model tables trimmed to the current catalog (aimlapi → Llama 3.3; gemini → 3.1/3 replacing 2.5/2.0), and the Codex ChatGPT connection flow now matches the OpenAI/ChatGPT selector path with the model-tier mapping table. The "currently available" phrasing is a good call given how often these catalogs churn.
No blockers from me — nice cleanup of the asset-move fallout.
Why / What / How
Several manually authored guides had broken relative links after documentation assets moved, stale model lists after catalog changes, outdated ChatGPT connection instructions, and an incomplete External API scope table. This PR updates those guides against the current
devsource, catalog, routes, and UI tests without touching generator-owned integration output.Changes 🏗️
WRITE_GRAPHandWRITE_LIBRARY.Agents and large language models used
Checklist 📋
For code changes:
poetry run python scripts/generate_block_docs.py --checkbash autogpt_platform/installer/test-single-container-handoff.shbackend/copilot/codex_model_router_test.py(8 passed)git diff --check origin/dev...HEADorigin/dev...HEADbackend/copilot/provider_tiers_test.py(the localSpinTestServerfixture stalled and was stopped after three minutes; no assertion failure was emitted)Example test plan
For configuration changes:
.env.defaultis updated or already compatible with my changesdocker-compose.ymlis updated or already compatible with my changesExamples of configuration changes
Note
Low Risk
Markdown and link fixes only; no runtime, auth, or API behavior changes.
Overview
Documentation-only refresh for platform guides that had broken assets, stale catalog text, and outdated integration UI wording.
Relative links and screenshots now point at
../content/imgs/...(AI/ML API, Ollama) and the docs landing page uses../platform/new_blocks.md. The External API guide links tooauth-guide.mdinstead of the removed SSO guide, and documentsWRITE_GRAPHandWRITE_LIBRARYscopes.Model tables in the AI/ML API, Gemini, and Ollama guides match the current LLM catalog (including a slimmer AI/ML API list and updated Gemini IDs); Ollama adds
llama3.3to the default compatible list.The ChatGPT/Codex subscription preview doc matches current UI: connect via Settings → Integrations → OpenAI → ChatGPT → Sign in with ChatGPT, AutoPilot tier controls are Balanced/Advanced, and Codex routing is explained with an execution-path × tier mapping table instead of the older Fast/Thinking prose.
Reviewed by Cursor Bugbot for commit 0d678fe. Bugbot is set up for automated code reviews on this repo. Configure here.