docs: clarify stable vs dev docs links for backend READMEs#12314
docs: clarify stable vs dev docs links for backend READMEs#12314tsubasakong wants to merge 8 commits intoSignificant-Gravitas:devfrom
Conversation
github-project-automation
bot
moved this to 🆕 Needs initial review
in AutoGPT development kanban
|
This PR targets the Automatically setting the base branch to |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughTwo README files in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@autogpt_platform/backend/README.md`:
- Around line 6-8: Update the broken documentation links in README.md: replace
the invalid https://docs.agpt.co/platform/getting-started/#autogpt_agent_server
and https://dev-docs.agpt.co/platform/getting-started/ entries with working URLs
or local doc references (e.g., the canonical public docs URL and a valid
dev-docs host or a relative ./docs/getting-started.md path), and ensure the
anchor (`#autogpt_agent_server`) matches an existing heading; verify by opening
the new URLs and adjust the README text ("uses the docs site as the single
source of truth") to point to the chosen canonical location so users can access
the getting-started doc.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: da0e53d2-ab15-4ea4-9406-fc6caeaebe94
📒 Files selected for processing (2)
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: types
- GitHub Check: test (3.13)
- GitHub Check: test (3.12)
- GitHub Check: test (3.11)
- GitHub Check: Check PR Status
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
📚 Learning: 2026-03-04T23:57:54.091Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Applied to files:
autogpt_platform/backend/README.mdautogpt_platform/backend/README.advanced.md
📚 Learning: 2026-03-04T23:58:09.319Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Applied to files:
autogpt_platform/backend/README.mdautogpt_platform/backend/README.advanced.md
📚 Learning: 2026-02-27T15:59:00.370Z
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:9983-9995
Timestamp: 2026-02-27T15:59:00.370Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — Backend/frontend OpenAPI codegen
Learning: For MCP schema models, required OpenAPI fields must have no defaults in Pydantic. Specifically, MCPToolInfo.input_schema must be required (no Field(default_factory=dict)) so openapi.json emits it in "required", ensuring generated TS types treat input_schema as non-optional.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:50:51.495Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-04T16:50:51.495Z
Learning: See `docs/content/platform/getting-started.md` for setup instructions
Applied to files:
autogpt_platform/backend/README.mdautogpt_platform/backend/README.advanced.md
📚 Learning: 2026-02-26T17:02:22.448Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12211
File: .pre-commit-config.yaml:160-179
Timestamp: 2026-02-26T17:02:22.448Z
Learning: Keep the pre-commit hook pattern broad for autogpt_platform/backend to ensure OpenAPI schema changes are captured. Do not narrow to backend/api/ alone, since the generated schema depends on Pydantic models across multiple directories (backend/data/, backend/blocks/, backend/copilot/, backend/integrations/, backend/util/). Narrowing could miss schema changes and cause frontend type desynchronization.
Applied to files:
autogpt_platform/backend/README.mdautogpt_platform/backend/README.advanced.md
🔇 Additional comments (2)
autogpt_platform/backend/README.md (1)
10-10: Excellent cross-referencing between README files.The bidirectional references between
README.mdandREADME.advanced.mdcreate helpful navigation for users looking for either standard or advanced setup instructions. This aligns well with the PR objective to consolidate documentation.autogpt_platform/backend/README.advanced.md (1)
6-8: Verify URL fragments against live documentation.The anchor fragments
#autogpt_agent_server_advanced_set_upin both documentation links need manual verification against the actual heading IDs on the target pages. Access the documentation sites directly to confirm these anchors match the generated heading IDs in the advanced_setup documentation.
autogpt-reviewer
left a comment
autogpt-reviewer
left a comment
There was a problem hiding this comment.
📋 PR #12314 — "docs: clarify stable vs dev docs links for backend READMEs"
Author: tsubasakong | Files: README.md (+10/-1), README.advanced.md (+10/-1), executor/utils.py (+4/-3), executor/utils_test.py (+4/-8) | Fixes: #8887
🎯 Verdict: REQUEST_CHANGES
What This PR Does
Restructures two backend README files to clearly distinguish stable (docs.agpt.co) vs development (dev-docs.agpt.co) documentation, with cross-references between them. Also includes a workspace import refactor in executor/utils.py that aligns the import pattern with the established *_db module convention — this is actually a subtle bug fix ensuring workspace operations properly participate in the Prisma connection branching.
Specialist Findings
🛡️ Security ✅ — No vulnerabilities. Pure mechanical refactor, no auth/access control changes.
🏗️ Architecture ✅ — Import refactor is consistent with established execution_db/graph_db/user_db/onboarding_db convention. Notes this is actually a bug fix: old code bypassed prisma.is_connected() branching for workspace. The wdb variable now correctly participates in the connected/disconnected client selection. Flags mixed scope (docs + code in one PR).
⚡ Performance ✅ — Zero overhead difference. Module-level import vs function import both load the full module. Attribute lookup adds negligible nanoseconds.
🧪 Testing ✅ — Mock pattern correctly updated from patching imported function to patching module reference. Both affected tests updated consistently. No other tests at risk of breaking. Verified against entire codebase.
📖 Quality docs: is misleading — includes code changes. Documentation markdown is clean and well-formatted. Link validity is questionable (see blockers).
📦 Product
📬 Discussion
🔎 QA
docs.agpt.co→ redirects toagpt.co/docs/...→ HTTP 400dev-docs.agpt.co→ SSL cert mismatch (*.netlify.app) + HTTP 404- Anchor fragments (
#autogpt_agent_server,#autogpt_agent_server_advanced_set_up) don't exist on target pages
📸 QA Screenshots:
🔴 Blockers
-
CLA unsigned — tsubasakong has not signed the Contributor License Agreement (2/3 committers signed). Cannot merge per project policy.
-
All 4 documentation links are broken — The entire purpose of this PR is to clarify docs links, but every link resolves to an error:
docs.agpt.co/platform/getting-started/→ 301 → HTTP 400 ("invalid proxy url for site")docs.agpt.co/platform/advanced_setup/→ 301 → HTTP 400dev-docs.agpt.co/platform/getting-started/→ SSL cert error + 404dev-docs.agpt.co/platform/advanced_setup/→ SSL cert error + 404
Note: These links were already broken in the old READMEs — this is a pre-existing infrastructure issue. However, since the PR expands these from bare single-line links to prominently formatted docs, it should fix them to working URLs before merge.
-
Anchor fragments don't exist —
#autogpt_agent_serverand#autogpt_agent_server_advanced_set_upare not actual heading IDs on the target pages (which are index/listing pages, not section-anchored content).
🟡 Should Fix (Follow-up OK)
-
Misleading commit type —
docs:prefix implies documentation-only, but PR includes a code refactor inexecutor/utils.py. Update title to reflect both scopes or split into separate commits. -
PR description says "docs-only change" but checklist should acknowledge the code change for accurate reviewer triage.
🟢 Positive Notes
- The import refactor in
utils.pyis a genuine improvement — fixes workspace bypassing the Prisma connection check, aligns with established conventions. - README restructuring is well-formatted with clear stable/dev distinction and cross-references.
- Test mocks updated correctly and consistently.
Risk Assessment
Merge risk: LOW | Rollback: EASY
The code change is a safe mechanical refactor. The docs changes are non-functional. Primary risk is shipping prominently broken links.
Recommended Actions
- @tsubasakong — Sign the CLA at https://cla-assistant.io/Significant-Gravitas/AutoGPT?pullRequest=12314
- Verify current working URLs for docs.agpt.co and dev-docs.agpt.co — the domain/path structure may have changed
- Update anchor fragments to match actual heading IDs on the docs site
- Consider updating PR title to reflect the code change scope
@ntindle Small docs + import consistency PR. Code change is clean (actually a bug fix). Blocked on CLA + all 4 doc links being broken. Close to mergeable once URLs are fixed.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@autogpt_platform/backend/README.advanced.md`:
- Around line 5-8: Replace the relative paths in README.advanced.md with the
deployed documentation URLs and clearly label branch mappings: change the
"Released / stable docs (`master` source)" entry to point to
https://docs.agpt.co/platform/advanced_setup (or the exact deployed path) and
the "Development docs (`dev` source)" entry to point to
https://dev-docs.agpt.co/platform/advanced_setup, keeping the parenthetical
branch names (`master`, `dev`) to show the mapping; update the two list items
that currently contain "../../docs/platform/advanced_setup.md" so they display
the correct deployed site URLs and branch labels.
In `@autogpt_platform/backend/README.md`:
- Around line 7-8: Update the "Development docs (`dev` source in this repo)"
line in README.md to reference the deployed dev-docs.agpt.co URL and mention
both deployed doc sites per the PR objectives: state that the dev branch maps to
dev-docs.agpt.co and the master branch maps to docs.agpt.co (you can keep the
existing relative path ../../docs/platform/getting-started.md as an inline repo
link but add the live URLs and brief mapping text for clarity).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c73faa6b-3f68-4ea2-a465-943e465229ca
📒 Files selected for processing (2)
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: types
- GitHub Check: test (3.13)
- GitHub Check: test (3.11)
- GitHub Check: test (3.12)
- GitHub Check: Check PR Status
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/backend/.env* : Backend configuration should use `.env.default` for defaults (tracked in git) and `.env` for user-specific overrides (gitignored)
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/backend/CLAUDE.md:0-0
Timestamp: 2026-02-04T16:50:20.508Z
Learning: Applies to autogpt_platform/backend/**/{.env.default,.env} : Use `.env.default` for default environment configuration and `.env` for user overrides in the backend
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Refer to 'autogpt_platform/frontend/CONTRIBUTING.md' and 'autogpt_platform/frontend/.cursorrules' for comprehensive frontend patterns and conventions
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/**/.env* : Platform-level configuration should use `.env.default` (Supabase/shared defaults, tracked in git) and `.env` for user overrides (gitignored)
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/backend/backend/api/features/**/*.py : Update routes in '/backend/backend/api/features/' and add/update Pydantic models in the same directory for API development
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/frontend/.env* : Frontend configuration should use `.env.default` for defaults (tracked in git) and `.env` for user-specific overrides (gitignored)
📚 Learning: 2026-03-04T23:58:09.319Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Applied to files:
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📚 Learning: 2026-03-04T23:57:54.091Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Applied to files:
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:50:51.495Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-04T16:50:51.495Z
Learning: See `docs/content/platform/getting-started.md` for setup instructions
Applied to files:
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📚 Learning: 2026-02-26T17:02:22.448Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12211
File: .pre-commit-config.yaml:160-179
Timestamp: 2026-02-26T17:02:22.448Z
Learning: Keep the pre-commit hook pattern broad for autogpt_platform/backend to ensure OpenAPI schema changes are captured. Do not narrow to backend/api/ alone, since the generated schema depends on Pydantic models across multiple directories (backend/data/, backend/blocks/, backend/copilot/, backend/integrations/, backend/util/). Narrowing could miss schema changes and cause frontend type desynchronization.
Applied to files:
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
📚 Learning: 2026-03-01T07:59:02.311Z
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:10030-10037
Timestamp: 2026-03-01T07:59:02.311Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — For MCP manual token storage, backend model autogpt_platform/backend/backend/api/features/mcp/routes.py defines MCPStoreTokenRequest.token as Pydantic SecretStr with a min length constraint, which generates OpenAPI schema metadata (format: "password", writeOnly: true, minLength: 1) in autogpt_platform/frontend/src/app/api/openapi.json. Prefer SecretStr (with length constraints) for sensitive request fields so generated TS clients and docs treat them as secrets.
Applied to files:
autogpt_platform/backend/README.md
🔇 Additional comments (1)
autogpt_platform/backend/README.md (1)
6-6: No changes needed - the stable docs URL is correct and intentional.The URL
https://agpt.co/docs/platform/getting-started/getting-startedis accessible and correct. This domain format represents the new documentation structure, as confirmed by the Cloudflare worker redirect migration fromdocs.agpt.cotoagpt.co/docs. The relative path for development docs is also appropriate for pointing to the local source files.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
autogpt_platform/backend/README.md (1)
6-6:⚠️ Potential issue | 🔴 CriticalDevelopment docs URL is unreachable.
The stable docs URL (
https://agpt.co/docs/platform/getting-started/getting-started) is working correctly and the path structure with/getting-started/getting-startedis intentional and verified. However, the development docs URL (https://dev-docs.agpt.co/platform/getting-started/getting-started) returns HTTP 000 and is not accessible. This blocks users on thedevbranch from reaching the documentation.Consider adding a repo source fallback for the stable docs section (line 6) for consistency with the dev docs pattern (line 9).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@autogpt_platform/backend/README.md` at line 6, The stable docs link at https://agpt.co/docs/platform/getting-started/getting-started should include a repository-source fallback like the dev docs do; update README.md to add an alternate/staged link or note pointing to the repository copy of the same docs (mirror/fallback) so users on the dev branch can access documentation when the primary stable URL is unreachable—match the dev-docs pattern around the dev URL and ensure the stable URL (https://agpt.co/docs/platform/getting-started/getting-started) has an equivalent repo-fallback entry.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@autogpt_platform/backend/README.md`:
- Line 6: The stable docs link at
https://agpt.co/docs/platform/getting-started/getting-started should include a
repository-source fallback like the dev docs do; update README.md to add an
alternate/staged link or note pointing to the repository copy of the same docs
(mirror/fallback) so users on the dev branch can access documentation when the
primary stable URL is unreachable—match the dev-docs pattern around the dev URL
and ensure the stable URL
(https://agpt.co/docs/platform/getting-started/getting-started) has an
equivalent repo-fallback entry.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 20ab915a-2c2e-4e0e-bfbf-fc31fc640d09
📒 Files selected for processing (2)
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
✅ Files skipped from review due to trivial changes (1)
- autogpt_platform/backend/README.advanced.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: types
- GitHub Check: test (3.11)
- GitHub Check: test (3.13)
- GitHub Check: test (3.12)
- GitHub Check: Check PR Status
🧰 Additional context used
🧠 Learnings (8)
📓 Common learnings
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/backend/backend/api/features/**/*.py : Update routes in '/backend/backend/api/features/' and add/update Pydantic models in the same directory for API development
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/frontend/**/*.{tsx,ts} : Use generated API hooks from '@/app/api/__generated__/endpoints/' instead of deprecated 'BackendAPI' or 'src/lib/autogpt-server-api/*'
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:9983-9995
Timestamp: 2026-02-27T15:59:00.370Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — Backend/frontend OpenAPI codegen
Learning: For MCP schema models, required OpenAPI fields must have no defaults in Pydantic. Specifically, MCPToolInfo.input_schema must be required (no Field(default_factory=dict)) so openapi.json emits it in "required", ensuring generated TS types treat input_schema as non-optional.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Refer to 'autogpt_platform/frontend/CONTRIBUTING.md' and 'autogpt_platform/frontend/.cursorrules' for comprehensive frontend patterns and conventions
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/backend/.env* : Backend configuration should use `.env.default` for defaults (tracked in git) and `.env` for user-specific overrides (gitignored)
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/backend/CLAUDE.md:0-0
Timestamp: 2026-02-04T16:50:20.508Z
Learning: Applies to autogpt_platform/backend/backend/api/features/**/*.py : When modifying API routes, update corresponding Pydantic models in the same directory and write tests alongside the route file
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/backend/**/test/**/*.py : Use snapshot testing with '--snapshot-update' flag in backend tests when output changes; always review with 'git diff'
📚 Learning: 2026-03-04T23:57:54.091Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-03-04T23:58:09.319Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:49:42.490Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/frontend/**/*.{tsx,ts} : Use generated API hooks from '@/app/api/__generated__/endpoints/' instead of deprecated 'BackendAPI' or 'src/lib/autogpt-server-api/*'
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-03-01T07:59:02.311Z
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:10030-10037
Timestamp: 2026-03-01T07:59:02.311Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — For MCP manual token storage, backend model autogpt_platform/backend/backend/api/features/mcp/routes.py defines MCPStoreTokenRequest.token as Pydantic SecretStr with a min length constraint, which generates OpenAPI schema metadata (format: "password", writeOnly: true, minLength: 1) in autogpt_platform/frontend/src/app/api/openapi.json. Prefer SecretStr (with length constraints) for sensitive request fields so generated TS clients and docs treat them as secrets.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-26T21:29:27.619Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Create Pull Requests against the `dev` branch, not `master`. The `master` branch is reserved for production releases only.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:50:51.495Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-04T16:50:51.495Z
Learning: See `docs/content/platform/getting-started.md` for setup instructions
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-26T17:02:22.448Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12211
File: .pre-commit-config.yaml:160-179
Timestamp: 2026-02-26T17:02:22.448Z
Learning: Keep the pre-commit hook pattern broad for autogpt_platform/backend to ensure OpenAPI schema changes are captured. Do not narrow to backend/api/ alone, since the generated schema depends on Pydantic models across multiple directories (backend/data/, backend/blocks/, backend/copilot/, backend/integrations/, backend/util/). Narrowing could miss schema changes and cause frontend type desynchronization.
Applied to files:
autogpt_platform/backend/README.md
🔇 Additional comments (2)
autogpt_platform/backend/README.md (2)
7-9: Good addition of both deployed URL and repo source.The development docs section now includes both the deployed dev-docs.agpt.co URL and the local repo source fallback. This addresses the previous review feedback and provides users with multiple access methods.
11-11: Clean cross-reference to advanced setup.The reference to
README.advanced.mdprovides clear navigation to additional documentation.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@autogpt_platform/backend/README.md`:
- Around line 5-6: Update the stable-docs host in the README entry titled
"**Released / stable docs (`master` source)**" to match the branch mapping in
the PR (replace the URL
"https://agpt.co/docs/platform/getting-started/getting-started" with the
canonical "https://docs.agpt.co/..." host used for master), or alternatively
revise the heading text to indicate the README intentionally points to agpt.co
if the canonical host actually changed; locate the exact line containing the
"**Released / stable docs (`master` source)**" header and the URL and make the
host consistent with the PR mapping.
- Around line 7-10: The repo-source fallback path in README.md is pointing to
../../docs/platform/getting-started.md but the canonical doc now appears under
docs/content/platform/getting-started.md; update the fallback reference in
autogpt_platform/backend/README.md to point to
docs/content/platform/getting-started.md (or run the suggested fd commands to
confirm exact filename/location), and ensure any other similar entries (e.g.,
the dev source link) are updated to the new docs/content/platform/ path so
contributors are routed to the correct source file.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 385f2e9c-d9ed-4cb2-9aa6-d36294819be5
📒 Files selected for processing (2)
autogpt_platform/backend/README.advanced.mdautogpt_platform/backend/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- autogpt_platform/backend/README.advanced.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: test (3.13)
- GitHub Check: test (3.11)
- GitHub Check: test (3.12)
- GitHub Check: Check PR Status
🧰 Additional context used
🧠 Learnings (8)
📓 Common learnings
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/backend/backend/api/features/**/*.py : Update routes in '/backend/backend/api/features/' and add/update Pydantic models in the same directory for API development
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/backend/.env* : Backend configuration should use `.env.default` for defaults (tracked in git) and `.env` for user-specific overrides (gitignored)
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Refer to 'autogpt_platform/frontend/CONTRIBUTING.md' and 'autogpt_platform/frontend/.cursorrules' for comprehensive frontend patterns and conventions
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/frontend/**/*.{tsx,ts} : Use generated API hooks from '@/app/api/__generated__/endpoints/' instead of deprecated 'BackendAPI' or 'src/lib/autogpt-server-api/*'
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:9983-9995
Timestamp: 2026-02-27T15:59:00.370Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — Backend/frontend OpenAPI codegen
Learning: For MCP schema models, required OpenAPI fields must have no defaults in Pydantic. Specifically, MCPToolInfo.input_schema must be required (no Field(default_factory=dict)) so openapi.json emits it in "required", ensuring generated TS types treat input_schema as non-optional.
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Applies to autogpt_platform/**/.env* : Platform-level configuration should use `.env.default` (Supabase/shared defaults, tracked in git) and `.env` for user overrides (gitignored)
📚 Learning: 2026-03-04T23:57:54.091Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:5593-5593
Timestamp: 2026-03-04T23:57:54.091Z
Learning: In Significant-Gravitas/AutoGPT backend (FastAPI), openapi.json is autogenerated: descriptions come from route docstrings and schemas from response_model/type annotations. To prevent drift when models are renamed (e.g., AdminView variants), avoid embedding specific schema class names in route docstrings; instead describe behavior, or keep names synced via backend edits—never hand-edit frontend/src/app/api/openapi.json.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-03-04T23:58:09.319Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12284
File: autogpt_platform/frontend/src/app/api/openapi.json:11897-11900
Timestamp: 2026-03-04T23:58:09.319Z
Learning: Repo: Significant-Gravitas/AutoGPT — PR `#12284`
Backend/frontend OpenAPI codegen convention: In backend/api/features/store/model.py, the StoreSubmission and StoreSubmissionAdminView models define submitted_at: datetime | None, changes_summary: str | None, and instructions: str | None with no default. This is intentional to produce “required but nullable” fields in OpenAPI (properties appear in required[] and use anyOf [type, null]). This matches Prisma’s submittedAt DateTime? and changesSummary String?. Do not flag this as a required/nullable mismatch.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-03-01T07:59:02.311Z
Learnt from: majdyz
Repo: Significant-Gravitas/AutoGPT PR: 12213
File: autogpt_platform/frontend/src/app/api/openapi.json:10030-10037
Timestamp: 2026-03-01T07:59:02.311Z
Learning: Repo: Significant-Gravitas/AutoGPT PR: 12213 — For MCP manual token storage, backend model autogpt_platform/backend/backend/api/features/mcp/routes.py defines MCPStoreTokenRequest.token as Pydantic SecretStr with a min length constraint, which generates OpenAPI schema metadata (format: "password", writeOnly: true, minLength: 1) in autogpt_platform/frontend/src/app/api/openapi.json. Prefer SecretStr (with length constraints) for sensitive request fields so generated TS clients and docs treat them as secrets.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:49:42.490Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2026-02-04T16:49:42.490Z
Learning: Applies to autogpt_platform/frontend/**/*.{tsx,ts} : Use generated API hooks from '@/app/api/__generated__/endpoints/' instead of deprecated 'BackendAPI' or 'src/lib/autogpt-server-api/*'
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-26T21:29:27.619Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: autogpt_platform/CLAUDE.md:0-0
Timestamp: 2026-02-26T21:29:27.619Z
Learning: Create Pull Requests against the `dev` branch, not `master`. The `master` branch is reserved for production releases only.
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-04T16:50:51.495Z
Learnt from: CR
Repo: Significant-Gravitas/AutoGPT PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-04T16:50:51.495Z
Learning: See `docs/content/platform/getting-started.md` for setup instructions
Applied to files:
autogpt_platform/backend/README.md
📚 Learning: 2026-02-26T17:02:22.448Z
Learnt from: Pwuts
Repo: Significant-Gravitas/AutoGPT PR: 12211
File: .pre-commit-config.yaml:160-179
Timestamp: 2026-02-26T17:02:22.448Z
Learning: Keep the pre-commit hook pattern broad for autogpt_platform/backend to ensure OpenAPI schema changes are captured. Do not narrow to backend/api/ alone, since the generated schema depends on Pydantic models across multiple directories (backend/data/, backend/blocks/, backend/copilot/, backend/integrations/, backend/util/). Narrowing could miss schema changes and cause frontend type desynchronization.
Applied to files:
autogpt_platform/backend/README.md
autogpt_platform/backend/README.md
Outdated
| - **Released / stable docs (`master` source)**: | ||
| https://agpt.co/docs/platform/getting-started/getting-started |
There was a problem hiding this comment.
Align the stable-docs host with the stated branch mapping.
The PR objective explicitly maps master to docs.agpt.co, but this section points to agpt.co/docs/... instead. Please use the same host called out in the objective, or update the wording if the canonical stable docs host has changed.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@autogpt_platform/backend/README.md` around lines 5 - 6, Update the
stable-docs host in the README entry titled "**Released / stable docs (`master`
source)**" to match the branch mapping in the PR (replace the URL
"https://agpt.co/docs/platform/getting-started/getting-started" with the
canonical "https://docs.agpt.co/..." host used for master), or alternatively
revise the heading text to indicate the README intentionally points to agpt.co
if the canonical host actually changed; locate the exact line containing the
"**Released / stable docs (`master` source)**" header and the URL and make the
host consistent with the PR mapping.
autogpt_platform/backend/README.md
Outdated
| (repo source: `../../docs/platform/getting-started.md`) | ||
| - **Development docs (`dev` source)**: | ||
| https://dev-docs.agpt.co/platform/getting-started/getting-started | ||
| (repo source: `../../docs/platform/getting-started.md`) |
There was a problem hiding this comment.
Verify the repo-source fallback path.
The fallback path here looks out of sync with the current docs layout. If the canonical file now lives under docs/content/platform/, these references will send contributors to the wrong source file.
#!/bin/bash
# Verify where the getting-started doc actually lives in the repo.
fd '^getting-started\.md$' docs -t f
fd '^advanced_setup\.md$' docs -t fBased on learnings, see docs/content/platform/getting-started.md for setup instructions.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@autogpt_platform/backend/README.md` around lines 7 - 10, The repo-source
fallback path in README.md is pointing to ../../docs/platform/getting-started.md
but the canonical doc now appears under
docs/content/platform/getting-started.md; update the fallback reference in
autogpt_platform/backend/README.md to point to
docs/content/platform/getting-started.md (or run the suggested fd commands to
confirm exact filename/location), and ensure any other similar entries (e.g.,
the dev source link) are updated to the new docs/content/platform/ path so
contributors are routed to the correct source file.
autogpt-reviewer
left a comment
autogpt-reviewer
left a comment
There was a problem hiding this comment.
📋 PR #12314 — "docs: clarify stable vs dev docs links for backend READMEs" (Re-review, Iteration 2)
Author: tsubasakong | Files: README.md (+12/-1), README.advanced.md (+12/-1), executor/utils.py (+4/-3), executor/utils_test.py (+4/-8) | Fixes: #8887
HEAD: 2763d468 | Previous HEAD: 87b12a69 | New commits: 4
🎯 Verdict: APPROVE_WITH_CONDITIONS
What This PR Does
Restructures two backend README files to clearly distinguish stable (agpt.co/docs) vs development (dev-docs.agpt.co) documentation, with branch-to-site mappings and repo-source fallback paths. Also includes a workspace import refactor in executor/utils.py that aligns the import pattern with the established *_db module convention — this is actually a subtle bug fix ensuring workspace operations properly participate in the Prisma is_connected() connection-routing logic.
Changes Since Last Review
The author has been highly responsive — 4 new commits in ~2.5 hours addressing CodeRabbit and our previous feedback:
- ✅ Stable docs URLs now work —
agpt.co/docs/platform/getting-started/getting-startedand.../advanced-setup/advanced_setupboth return HTTP 200 - ✅ Repo-source fallback paths added —
../../docs/platform/getting-started.mdand../../docs/platform/advanced_setup.mdboth verified to exist ⚠️ dev-docs.agpt.costill dead — SSL cert mismatch + 404 site-wide (pre-existing infrastructure issue)- 🔴 CLA still unsigned — no change
Specialist Findings
🛡️ Security ✅ — No vulnerabilities. The import refactor is security-positive: closes a gap where workspace DB calls bypassed the prisma.is_connected() connection-routing that all other DB modules follow.
🏗️ Architecture ✅ — Import pattern now matches established execution_db/graph_db/user_db/onboarding_db convention. Correctly fixes Prisma connection-state branching bypass. Minor note: chat/routes.py and review/routes.py still use direct imports (non-blocking, those run in request context where Prisma is always connected).
⚡ Performance ✅ — Zero meaningful overhead. Module-level import is identical cost; attribute lookup adds ~50ns per call, immeasurable vs DB round-trips in add_graph_execution.
🧪 Testing ✅ — Mock pattern correctly updated from function patch to module patch. Both affected test functions updated consistently. Pattern matches existing *_db mock conventions in the same file.
📖 Quality docs: remains misleading (includes production code changes). dev-docs.agpt.co links confirmed dead (404 on Netlify). README formatting is improved but parenthetical notes are verbose.
📦 Product getting-started/getting-started vs advanced-setup/advanced_setup) appears to reflect actual routing, not a PR bug.
📬 Discussion
🔎 QA
📸 QA Screenshots:
Conditions for Merge
-
🔴 CLA must be signed — tsubasakong has not signed the Contributor License Agreement (2/3 committers signed). Cannot merge per project policy. Sign at: https://cla-assistant.io/Significant-Gravitas/AutoGPT?pullRequest=12314
-
🟠
dev-docs.agpt.colinks need resolution — The entiredev-docs.agpt.codomain is down (SSL cert mismatch for*.netlify.app+ returns 404). This is a pre-existing infrastructure issue, but the PR prominently links to it. Either:- Confirm the domain is expected to come back (acceptable as-is with the repo-source fallbacks)
- Or add a note that dev-docs may not be deployed yet
- Or remove the URLs and keep only the repo-source paths
Should Fix (Follow-up OK)
-
Misleading PR title —
docs:prefix implies documentation-only, but includes a production code refactor inexecutor/utils.py. Considerrefactor(backend): use workspace_db module pattern + clarify README doc linksor split into separate commits. -
Verbose parenthetical notes — Lines like
(legacy docs.agpt.co host may not resolve this path; repo source: ../../docs/platform/advanced_setup.md)could be simplified for readability.
Positive Notes
- Import refactor is a genuine improvement — fixes workspace bypassing Prisma connection check, aligns with established conventions
- README quality significantly improved — from bare one-line links to structured docs with stable/dev distinction and cross-references
- Test mocks correctly and consistently updated
- Author is highly engaged — 5 iterative commits responding to feedback in rapid succession
- Stable docs URLs now verified working (200 OK) — major improvement over iteration 1
Risk Assessment
Merge risk: LOW | Rollback: EASY
The code change is a safe mechanical refactor that actually fixes a subtle bug. The docs changes are non-functional. Primary risk is shipping dead dev-docs.agpt.co links, mitigated by repo-source fallback paths.
CI Status
| Check | Status |
|---|---|
| Tests (3.11/3.12/3.13) | ✅ Pass |
| Types | ✅ Pass |
| CodeQL | ✅ Pass |
| license/cla | 🔴 Pending — NOT SIGNED |
@ntindle Small docs + import consistency PR. Code change is a genuine bug fix (workspace bypassing Prisma connection routing). Stable URLs now work ✅. Blocked on CLA + dead dev-docs.agpt.co domain (infra issue). Very close to mergeable — just needs CLA signature and a decision on the dev-docs URLs.
3 participants
Changes 🏗️
Implements docs single-source cleanup for backend READMEs.
autogpt_platform/backend/README.mdto point to docs site onlyautogpt_platform/backend/README.advanced.mdto point to docs site onlydocs.agpt.cofor released/stable (master)dev-docs.agpt.cofor development (dev)Fixes #8887
Checklist 📋
For code changes:
For configuration changes:
.env.defaultis updated or already compatible with my changesdocker-compose.ymlis updated or already compatible with my changes