docs: consolidate development artifacts - #56
Merged
Conversation
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
✅ Health: 8.8 📋 At a glance Files & modules (2)
📌 Before you merge
🔎 More signals (3)🗺️ Change map flowchart LR
subgraph PR ["Changed in this PR (4 with dependents)"]
f_backend_pipeline_pipeline_py["backend/pipeline/pipeline.py 🔥"]:::changed
f_backend_ws_agent_manager_py["backend/ws_agent_manager.py 🔥"]:::changed
f_backend_config_py["backend/config.py"]:::changed
f_backend_processors_openai_processor_py["backend/processors/openai_processor.py"]:::changed
end
f_backend_api_v1___init___py[".../v1/__init__.py"]
f_backend_pipeline_pipeline_py --> f_backend_api_v1___init___py
f_backend_main_py["backend/main.py"]
f_backend_pipeline_pipeline_py --> f_backend_main_py
f_backend_models___init___py["backend/models/__init__.py"]
f_backend_pipeline_pipeline_py --> f_backend_models___init___py
f_backend_pipeline_runner_py["backend/pipeline/runner.py"]
f_backend_pipeline_pipeline_py --> f_backend_pipeline_runner_py
f_backend_agent_server_py["backend/agent_server.py"]
f_backend_ws_agent_manager_py --> f_backend_agent_server_py
f_backend_channels_opencli_channel_py["backend/channels/opencli_channel.py"]
f_backend_ws_agent_manager_py --> f_backend_channels_opencli_channel_py
f_backend_config_py --> f_backend_api_v1___init___py
f_backend_api_v1_browsers_py[".../v1/browsers.py"]
f_backend_config_py --> f_backend_api_v1_browsers_py
f_backend_api_v1_nodes_py[".../v1/nodes.py"]
f_backend_config_py --> f_backend_api_v1_nodes_py
f_backend_api_v1_system_py[".../v1/system.py"]
f_backend_config_py --> f_backend_api_v1_system_py
f_backend_database_py["backend/database.py"]
f_backend_processors_openai_processor_py --> f_backend_database_py
f_backend_processors_openai_processor_py --> f_backend_main_py
more(["+6 more dependents"])
PR --> more
t_tests_unit_pipeline_test_pipeline_py(["✅ .../pipeline/test_pipeline.py"]):::guard
t_tests_unit_pipeline_test_pipeline_py -.-> f_backend_pipeline_pipeline_py
t_tests_integration_test_webhooks_api_py(["✅ tests/integration/test_webhooks_api.py"]):::guard
t_tests_integration_test_webhooks_api_py -.-> f_backend_config_py
classDef changed fill:#dbeafe,stroke:#1d4ed8,color:#1e3a5f
classDef warn fill:#fef3c7,stroke:#b45309,color:#78350f
classDef guard fill:#dcfce7,stroke:#15803d,color:#14532d
Solid arrows: code that imports the changed files (16 direct dependents, from the last indexed snapshot). Dashed: history/tests. 🔥 Hotspots touched (5)
2 more
💀 Dead code (10 findings)
7 more
📊 See the full report for this PR |
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe change removes obsolete planning and audit documents, adds repository documentation rules, and replaces historical goal and PR references across backend, frontend, documentation, and tests. Executable behavior and public declarations remain unchanged. ChangesRepository documentation cleanup
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
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 `@AGENTS.md`:
- Around line 20-27: Update the “Documentation Hygiene” guidance in AGENTS.md to
include root-level TODO* files alongside PLAN_*, GOAL*, HANDOFF*, and AUDIT* in
the prohibited transient-document patterns, while preserving the existing
instruction to track active plans and tasks in GitHub Issues.
In `@backend/agent_runtimes/base.py`:
- Line 5: Update the adapter description near the “ABC” reference so the
singular subject and verb agree, changing “an ABC adapters implement” to
singular “an ABC adapter implements” while preserving the surrounding meaning.
🪄 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: CHILL
Plan: Pro Plus
Run ID: 93f1fa93-cf4a-45cd-82d0-2114258cc515
📒 Files selected for processing (91)
.claude-project.mdAGENTS.mdAUDIT-cybernetic-remediation.mdGOAL-2.mdGOAL-3.mdGOAL-4.mdGOAL-5.mdGOAL-6.mdGOAL-7.mdGOAL-agent-runtimes.mdGOAL.mdGRILL-KICKOFF.mdHANDOFF-strangler-fig.mdLIVE_WEBHOOK_ACCEPTANCE.mdPLAN_adapter_selfheal.mdPLAN_collection_nodes.mdPLAN_general_analysis_loop.mdPLAN_native_nodes_loop.mdPLAN_plugin_system.mdPLAN_product_positioning.mdPLAN_realtime_tool_capabilities.mdPLAN_ui_reskin.mdPONYTAIL.mdREADME.mdTODOS.mdbackend/agent_runtimes/base.pybackend/agent_runtimes/pi_adapter.pybackend/agent_runtimes/registry.pybackend/api/v1/browser_act.pybackend/api/v1/chat.pybackend/api/v1/model_defaults.pybackend/api/v1/providers.pybackend/browser_act/__init__.pybackend/browser_act/cli.pybackend/browser_act/scripts.pybackend/browser_act_packs/VENDOR.mdbackend/browser_act_packs/catalog.pybackend/browser_act_packs/manifest.pybackend/channels/browser_act_channel.pybackend/channels/crawl4ai_channel.pybackend/channels/skill_channel.pybackend/config.pybackend/llm/__init__.pybackend/llm/anthropic.pybackend/llm/base.pybackend/llm/catalog.pybackend/llm/factory.pybackend/llm/openai_compat.pybackend/llm/resolver.pybackend/migrations/versions/c9d0e1f2a3b4_add_runtimes_to_edge_nodes.pybackend/migrations/versions/d8e9f0a1b2c3_add_provider_models_and_model_defaults.pybackend/models/model_default.pybackend/models/provider_model.pybackend/pipeline/ai_processor.pybackend/pipeline/pipeline.pybackend/processors/claude_processor.pybackend/processors/local_processor.pybackend/processors/openai_processor.pybackend/security/url_guard.pybackend/services/provider_model_service.pybackend/ws_agent_manager.pydocs/CONTROL_THEORY_ARCHITECTURE.mddocs/SYSTEM_ANALYSIS.mddocs/WIRING_GAP_LEDGER.mddocs/dify-p0-compatibility-runtime-PRD.mddocs/dify-p0-compatibility-runtime-issues/05-dify-manifest-intake-and-plugin-registry.mdfrontend/lib/api/endpoints.tsfrontend/lib/api/types.tstests/integration/test_auth_ws.pytests/integration/test_browser_act_packs_api.pytests/integration/test_browser_act_seeds.pytests/integration/test_model_defaults_api.pytests/integration/test_provider_models_api.pytests/unit/api/test_nodes_upsert.pytests/unit/browser_act/test_cli.pytests/unit/browser_act_packs/test_manifest.pytests/unit/channels/test_api_channel.pytests/unit/channels/test_browser_act_channel.pytests/unit/channels/test_web_scraper_channel.pytests/unit/llm/test_adapters.pytests/unit/llm/test_catalog.pytests/unit/llm/test_pr_e_consumers.pytests/unit/llm/test_resolver.pytests/unit/pipeline/test_ai_processor.pytests/unit/pipeline/test_pipeline_errors.pytests/unit/test_agent_server.pytests/unit/test_model_default.pytests/unit/test_provider_model.pytests/unit/test_runner.pytests/unit/test_schedule_service_redbeat.pytests/unit/worker/test_beat_schedule.py
💤 Files with no reviewable changes (24)
- LIVE_WEBHOOK_ACCEPTANCE.md
- PONYTAIL.md
- PLAN_ui_reskin.md
- GOAL-agent-runtimes.md
- PLAN_plugin_system.md
- PLAN_native_nodes_loop.md
- PLAN_collection_nodes.md
- PLAN_general_analysis_loop.md
- GOAL.md
- TODOS.md
- GOAL-6.md
- GOAL-3.md
- HANDOFF-strangler-fig.md
- GRILL-KICKOFF.md
- GOAL-7.md
- GOAL-4.md
- GOAL-2.md
- PLAN_adapter_selfheal.md
- AUDIT-cybernetic-remediation.md
- GOAL-5.md
- docs/dify-p0-compatibility-runtime-issues/05-dify-manifest-intake-and-plugin-registry.md
- .claude-project.md
- PLAN_realtime_tool_capabilities.md
- PLAN_product_positioning.md
Comment on lines
+20
to
+27
| ## Documentation Hygiene | ||
|
|
||
| - Keep the repository root limited to durable product, architecture, testing, | ||
| and agent-instruction entry points. | ||
| - Track active plans and tasks in GitHub Issues. Record durable architecture | ||
| decisions in `docs/adr/`; do not add root-level `PLAN_*`, `GOAL*`, `HANDOFF*`, | ||
| or `AUDIT*` files. | ||
|
|
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Prohibit future root-level TODO* documents.
The rule forbids PLAN_*, GOAL*, HANDOFF*, and AUDIT*, but it omits TODO*. Add TODO* so the transient documents removed by this PR cannot be reintroduced.
As per coding guidelines, active plans and tasks belong in GitHub Issues, and the repository root must contain only durable entry points.
🤖 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 `@AGENTS.md` around lines 20 - 27, Update the “Documentation Hygiene” guidance
in AGENTS.md to include root-level TODO* files alongside PLAN_*, GOAL*,
HANDOFF*, and AUDIT* in the prohibited transient-document patterns, while
preserving the existing instruction to track active plans and tasks in GitHub
Issues.
Source: Coding guidelines
| the caller branches on (never ``isinstance``), a small task/result value-object | ||
| pair, and an ``ABC`` adapters implement. See ``GOAL-agent-runtimes.md`` §2 for | ||
| the design rationale — the short version: the three target frameworks | ||
| pair, and an ``ABC`` adapters implement. The three target frameworks |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the grammar in the adapter description.
Line 5 says “an ABC adapters implement.” Rewrite the sentence so the subject and verb agree, for example: “an ABC adapter implements.”
🤖 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 `@backend/agent_runtimes/base.py` at line 5, Update the adapter description
near the “ABC” reference so the singular subject and verb agree, changing “an
ABC adapters implement” to singular “an ABC adapter implements” while preserving
the surrounding meaning.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification
uv run pytest tests/unit/test_public_release_contract.py -q --no-cov(2 passed)git diff --checkpassedKnown baseline
Targeted Ruff reported three pre-existing findings (
UP041x2,N818x1); rerun with those baseline rules ignored passed with no additional findings.