LearnNewsExamplesServices
Frontmatter
id11719
titleFix broken Section 6 table in Deployment Cookbook
stateClosed
labels
bugdocumentationai
assigneesneo-gpt
createdAtMay 21, 2026, 5:58 PM
updatedAtMay 22, 2026, 9:58 AM
githubUrlhttps://github.com/neomjs/neo/issues/11719
authorneo-gpt
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtMay 22, 2026, 9:58 AM

Fix broken Section 6 table in Deployment Cookbook

Closed v13.0.0/archive-v13-0-0-chunk-12 bugdocumentationai
neo-gpt
neo-gpt commented on May 21, 2026, 5:58 PM

Context

While reviewing cloud-deployment readiness in Discussion #11718, the operator asked for a fresh read of learn/agentos/DeploymentCookbook.md. That read surfaced a narrow documentation rendering bug in Section 6, separate from the larger topology/orchestrator discussion.

Duplicate sweep:

  • Live issue search for DeploymentCookbook Section 6 table broken found related historical cookbook/env-var tickets (#10800, #10808) but no equivalent table-rendering bug.
  • Knowledge Base ticket search found #10969, which updated env-var table content after deploy-compose changes. #10969 is not equivalent: it addressed missing rows/content, not a Markdown table split.
  • Local resources/content sweep found many Section 6 / env-var references, but no existing issue scoped to the broken Markdown table structure.

The Problem

DeploymentCookbook.md Section 6 renders as two tables because there is a blank line inside the Markdown table immediately after the first env-var row.

Current shape:

| Variable | Target | Purpose |
|---|---|---|
| `MCP_HTTP_PORT` | Both | The port the HTTP/SSE server listens on ... |

| `NEO_CHROMA_HOST` | Both | Internal URL of the Chroma instance. |

That blank line splits the environment-variable inventory, which makes the operator-facing table harder to scan and undermines the cookbook as a day-0 deployment reference.

The Architectural Reality

Relevant surface:

  • learn/agentos/DeploymentCookbook.md Section 6 is the human/agent-readable env-var inventory for KB/MC shared deployment.
  • Prior issue #10969 established that this cookbook table must stay aligned with deployment env vars.
  • Discussion #11718 is separately handling the larger architecture drift: the cookbook currently contains a Local Orchestrator Dev-Sync Roots subsection, not a production/containerized orchestrator deployment profile. This bug ticket should not solve that topology decision.

The fix belongs in documentation only.

The Fix

Remove the blank line that splits the Section 6 Markdown table so all env-var rows render as one continuous table.

Optionally run a Markdown/table sanity check or inspect rendered Markdown locally if the docs toolchain has one available.

Contract Ledger Matrix

Target Surface Source of Authority Proposed Behavior Fallback / Edge Case Docs Evidence
DeploymentCookbook.md Section 6 env-var table This bug; #10969 precedent; operator report during #11718 review Section 6 renders as one continuous Markdown table from header through final env-var row If future rows are added, they remain inside the same table without blank-line splits Same file Static diff plus rg/line inspection or Markdown render check

Acceptance Criteria

  • The blank line between the MCP_HTTP_PORT row and NEO_CHROMA_HOST row is removed.
  • Section 6 renders as one continuous table from Variable / Target / Purpose through NEO_MCP_GITHUB_ARCHIVE_ROOT.
  • No env-var content or topology semantics are changed by this bug fix.
  • Verification evidence includes either rendered Markdown inspection or a line-level/static check showing no blank line exists inside the table.

Out of Scope

  • Deciding whether the orchestrator belongs in the production container profile.
  • Updating ai/deploy/docker-compose.yml or docker-compose.test.yml.
  • Rewriting the cookbook for #11718 / v13 cloud-deployment readiness.
  • Adding or removing env-var rows.

Related

  • Discussion #11718 — cloud Agent OS deployment readiness and orchestrator/container topology.
  • #10969 — prior env-var inventory content update.
  • #10800 — original cloud deployment cookbook ticket.

Handoff Retrieval Hint: query_summaries(query="DeploymentCookbook Section 6 table broken env-var inventory") Handoff Retrieval Hint: query_raw_memories(query="Discussion 11718 local orchestrator deployment cookbook table split")

tobiu referenced in commit 413176c - "fix(docs): repair deployment cookbook env table (#11719) (#11748) on May 22, 2026, 9:58 AM
tobiu closed this issue on May 22, 2026, 9:58 AM