docs: replace docs/book with wiki as single source of truth - #72
docs: replace docs/book with wiki as single source of truth#72Lang-Akshay wants to merge 11 commits into
Conversation
lucarlig
left a comment
There was a problem hiding this comment.
We need an unique source of truth. We already have the book and the Summary.md please optimize that for AI rather than writing something new from scratch
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
c2345bc to
94954f2
Compare
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
…single true source of information Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
lucarlig
left a comment
There was a problem hiding this comment.
Requesting changes because deleting docs/book/ is not yet a lossless migration to the wiki, so the proposed single source of truth would omit durable architecture and integration guidance.
The MCP protocol guardrail is preserved: the wiki still targets MCP 2026-07-28 over Streamable HTTP, uses server/discover plus per-request client metadata for new tests/examples, and rejects new legacy compatibility. The blockers are the other material sections that currently have no wiki equivalent:
- Migrate the remaining architectural decisions from
architectural-choices.md: the “MCP-first, not MCP-only” protocol-neutral shell direction; transport-security ownership and its expected evolution; the requirements for expanding plugin hooks; and the architecture-change follow-through matrix. - Preserve the control-plane integration contract: its provisional/de-facto status, exact route and traffic split, required claim shape, MessagePack key/value contract, generation of both
schemas/user.jsonandschemas/user_config.json, and the rule that contract changes must be coordinated across the dataplane, publisher, and integration harness. - Preserve or explicitly account for the omitted hot-path/operational material from request flow, concurrency/runtime, plugins, testing, and telemetry. In particular, startup/response flow, progress-token synchronization, runtime/lock details, plugin behavior, configuration options, integration-test lanes, and known telemetry gaps should not silently disappear. If some content is intentionally retired, list it and explain why before removing the source.
There are also branch inconsistencies to fix:
_context/wiki/preferences.md:68and_context/wiki/project.md:54still instruct contributors to update the “book”._context/wiki/project.md:5and:94still usecontextforge-gateway-rs.README.mdcallsmake testing-up/testing-down, but this PR removes those Makefile targets.make docker-prodcreatescontextforge-data-plane:latest, whilecompose-upchecks fordataplane:latest.- The PR body and verification claim a
docs-servetarget, but the target is absent from the Makefile.
Please keep docs/book/ until the migration has an explicit chapter-to-wiki coverage checklist, or add the missing wiki pages/content in this PR and verify the resulting mdBook plus documented Make targets.
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
|
Thanks —
Local Markdown link targets are valid. |
cafalchio
left a comment
There was a problem hiding this comment.
We should have some mermaid for new contributors to understand the flow and architecture.
Signed-off-by: Lang-Akshay <akshay.shinde26@ibm.com>
|
Thanks for the Review @cafalchio . I have added mermaid diagram to the documentation. |
What
Replaces the mdBook-based
docs/book/with_context/wiki/as the single source of documentation — serving both AI agents and human readers from the same Markdown files.Why
The project had two parallel documentation surfaces (
docs/book/src/and_context/wiki/) that diverged in content and naming. Maintaining both meant every hot-path change required two updates. The wiki is now the sole authoritative source; mdBook renders it for human consumption.Changes
Deleted
docs/book/— entire directory (31 source files, 8 SVG assets,book.toml,SUMMARY.md).github/workflows/pages.yml— old book publish workflowWiki — new pages
security.md— trust boundaries, compromise impact, transport security, secrets handlingperformance.md— Goose dataplane-only load test, Locust full-stack, benchmark settingsWiki — updated pages
architecture.md— fixed staleContextForgeGatewayAppState→ContextForgeDataPlaneAppState; module boundary labelconfig.md— fixed env var prefixCONTEXTFORGE_GATEWAY_RS_*→CONTEXTFORGE_DATA_PLANE_*; fixed schema command; added local Langfuse/OTel/Prometheus stack and Prometheus starter queriesdeployment.md— fixed image tag info; added TLS choices tablegetting-started.md— added full local cargo dev workflow: service table,cargo runcommand, token minting, config seeding, mcp-inspector instructions,server/discoverprobe, troubleshooting tablepreferences.md— fixed stale crate paths and schema command; replaced book update rule with wiki update ruleproject.md— fixed all stalecontextforge-gateway-rs-*crate names tocontextforge-data-plane-*; replaced book links with wiki linksrouting.md— expanded capability merge with source-of-truth detail and merge rule listindex.md— added security and performance pages; fixed repo name; removed book referenceBook infrastructure — restored pointing at wiki
_context/wiki/book.toml— mdBook config (src = ".", edit links to correct GitHub path)_context/wiki/SUMMARY.md— four-section navigation (Project, Architecture, Operations, Contributing).github/workflows/pages.yml— same workflow shape, now watches_context/wiki/**and deploys from_context/wiki/book.gitignore— replaceddocs/book/book/with_context/wiki/book/Other
AGENTS.md— removed redundant architecture table (wiki index covers it); updated working rule to reference wiki instead of bookREADME.md— all book links replaced with wiki linksMakefile— addeddocs-servetarget (mdbook serve _context/wiki --hostname 127.0.0.1 --port 3000 --open)Verification
GitHub Pages publishes on push to
mainvia the restored workflow — same URL, same experience, wiki content.