Skip to content

docs: add Execution Backends nav section, surface docker-backend.md#740

Open
geoffjay wants to merge 4 commits intomainfrom
docs/fix-docker-backend-nav
Open

docs: add Execution Backends nav section, surface docker-backend.md#740
geoffjay wants to merge 4 commits intomainfrom
docs/fix-docker-backend-nav

Conversation

@geoffjay
Copy link
Copy Markdown
Owner

Summary

  • docs/docker-backend.md has existed since the Docker backend shipped but was never added to mkdocs.yml, making it unreachable via the docs site navigation
  • Adds a top-level Execution Backends section (between Installation-area pages and Services) with Docker as the first entry
  • Section is intentionally structured to receive Tmux and Pty entries when Implement PtyBackend for ExecutionBackend trait #673 (PtyBackend implementation) lands

Nav change

+ - Execution Backends:
+     - Docker: docker-backend.md
  - Development:
      ...

Related

Test plan

  • mkdocs build succeeds without warnings
  • Docker page renders at Execution Backends → Docker
  • No broken links introduced

🤖 Generated with Claude Code

- Commit ADR 0001 from architect agent's untracked file
- Create docs/planning/decisions/ directory structure
- Add Architecture Decisions section to mkdocs.yml nav under Development
- ADR status: Proposed — documents decision to use stdio/rmcp pass-through
  over HTTP server or CLI embedding, covering trade-offs, consequences,
  and implementation notes for the crates/mcp/ scaffold (#249)
docker-backend.md has existed since the Docker backend shipped but was
never added to the mkdocs.yml nav, making it undiscoverable via the
docs site. Adds a top-level 'Execution Backends' section with the Docker
entry as the first item — structured to receive Tmux and Pty entries
when #673 (PtyBackend) lands.
@geoffjay geoffjay added the review-agent Used to invoke a review by an agent tracking this label label Mar 23, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.66%. Comparing base (a5867f0) to head (2829dfe).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #740   +/-   ##
=======================================
  Coverage   55.66%   55.66%           
=======================================
  Files         126      126           
  Lines       13759    13760    +1     
=======================================
+ Hits         7659     7660    +1     
  Misses       6100     6100           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Owner Author

@geoffjay geoffjay left a comment

Choose a reason for hiding this comment

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

Review: docs — add Execution Backends nav section

Stack position: docs/fix-docker-backend-nav sits under design/issue-676 (#716) in the
local git-spice stack, but the PR targets main directly and has no (needs restack) flag.
No parent PR dependency to block merge.

The Execution Backends section placement in mkdocs.yml is correct and the
structure is well-prepared for future Tmux and Pty entries. One issue needs
fixing before this can merge.


Blocking — must fix

Out-of-scope content: ADR file and its nav entry belong on a different branch

The diff contains two items the PR description doesn't mention — and that have
nothing to do with surfacing docker-backend.md:

  1. docs/planning/decisions/0001-agentd-mcp-stdio-transport.md — a new
    149-line ADR (creates the docs/planning/decisions/ directory from scratch)
  2. Architecture Decisions nav entry in mkdocs.yml (under Development)
    pointing to that ADR

The PR description says "nav wiring only" and "The existing
docker-backend.md content is unchanged", but this PR introduces a new file.

git-spice log short shows docs/adr-0001-agentd-mcp as a dedicated branch
for this ADR that hasn't been submitted as a PR yet. The ADR content should live
there — not here. This is the same pattern as PR #744, where orchestrator
webhook tests were accidentally committed to the agentd-mcp plan branch.

Fix: remove docs/planning/decisions/0001-agentd-mcp-stdio-transport.md
and the Architecture Decisions nav block from this branch, then commit them
to docs/adr-0001-agentd-mcp and submit that as its own PR.

Once those two items are stripped, the remaining change (the Execution Backends section) is clean and ready to merge.


The docker-backend nav change itself looks good

No issues with the intended change:

  • docker-backend.md exists at the expected path — verified.
  • Section placement (after Pipeline, before Development) is appropriate for
    infrastructure reference content.
  • The section is correctly structured to receive Tmux and Pty entries from #673
    without another nav reorganisation.

@geoffjay geoffjay added needs-rework PR has review feedback that must be addressed before merging and removed review-agent Used to invoke a review by an agent tracking this label labels Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rework PR has review feedback that must be addressed before merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant