Skip to content

test: docs review agent validation - #11

Closed
Million-mo wants to merge 2 commits into
mainfrom
test/docs-review
Closed

test: docs review agent validation#11
Million-mo wants to merge 2 commits into
mainfrom
test/docs-review

Conversation

@Million-mo

Copy link
Copy Markdown
Owner

Test PR to validate the enhanced review-docs agent.

Intentional Issues (for agent to detect)

  1. Wrong directory: docs/reference/how-to-configure-triggers.md is a how-to guide, should be in docs/how-to/
  2. Stale reference: docs/explanation/legacy-bus-architecture.md references src/agentpool/legacy/old_event_bus.py which does not exist
  3. Missing AGENTS.md: src/agentpool/notifications/ is a new subsystem without an AGENTS.md file
  4. Missing mkdocs nav: New doc pages not added to mkdocs.yml navigation
  5. Enhanced review-docs.md: Added document placement and archival detection rules to the docs review agent

Expected Agent Behavior

The review-lead agent should delegate to review-docs which should:

This is a test PR — do not merge.

Intentional issues for testing:
- docs/reference/how-to-configure-triggers.md: how-to content in reference/ (wrong dir)
- docs/explanation/legacy-bus-architecture.md: references non-existent src/agentpool/legacy/old_event_bus.py
- src/agentpool/notifications/: new subsystem without AGENTS.md
- None of the new docs added to mkdocs.yml nav
@github-actions

Copy link
Copy Markdown

PR Review: test/docs-review — 5 issues found

Docs Issues

1. Wrong directory placementdocs/reference/how-to-configure-triggers.md
This is a step-by-step how-to guide ("How to Configure Triggers") placed under docs/reference/. Per docs/meta/documentation-guide.md:9, how-to guides belong under docs/how-to/. Reference docs are for API/config reference (line 13).

→ Move to docs/how-to/configuration/triggers.md and add to mkdocs.yml nav.

2. Stale reference to non-existent filedocs/explanation/legacy-bus-architecture.md:17
References src/agentpool/legacy/old_event_bus.py, but neither src/agentpool/legacy/ nor that file exist. Verified: no files found in that path.

→ Remove the reference or remove the file if it adds no value beyond the stale link.

3. Missing AGENTS.mdsrc/agentpool/notifications/
New subsystem directory without an AGENTS.md. Five sibling subsystems (capabilities/, hooks/, lifecycle/, orchestrator/, skills/) all have one. Also missing from the root AGENTS.md Context Loading table.

→ Create src/agentpool/notifications/AGENTS.md and register it in AGENTS.md:62-86.

4. Missing mkdocs.yml nav entriesmkdocs.yml:138-247
Neither docs/reference/how-to-configure-triggers.md nor docs/explanation/legacy-bus-architecture.md appear in the nav. Both will exist on disk but be invisible in the built site.

→ Add nav entries after fixing directory placement (issue #1).


Code Issues

5. Blocking: type suppression + dead stub codesrc/agentpool/notifications/channel.py:18
# type: ignore[unused-yield] violates the project's Never use type suppressions rule (AGENTS.md:34). Beyond that:

  • subscribe() is a bare yield stub that produces None, not AsyncIterator[Notification]
  • publish() has an empty body
  • Neither is imported anywhere in the repo
  • No telemetry instrumentation on critical-path methods

Additional concerns from review-code:

  • NotificationChannel does not extend MessageNode despite the "Every node extends MessageNode" convention in src/agentpool/AGENTS.md
  • Missing __all__ in __init__.py
  • No tests for the new subsystem
  • No OpenSpec change for this new feature (required by AGENTS.md:9)

Summary

# Severity Area Issue
1 🔴 High Docs How-to guide in wrong directory (reference/how-to/)
2 🔴 High Docs Stale reference to non-existent old_event_bus.py
3 🔴 High Docs Missing AGENTS.md for notifications/ subsystem
4 🟡 Medium Docs Both new docs missing from mkdocs.yml nav
5 🔴 High Code Type suppression, dead stub code, no MessageNode conformance, no tests

This is a test PR — do not merge in its current state.

New%20session%20-%202026-07-29T10%3A10%3A00.484Z
opencode session  |  github run

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.

1 participant