New example: with-doc-bridge — deterministic documentation handoffs for coding agents

[EmersonBraun]

Goals

1. Show how a Turborepo can give coding agents package-scoped context: where to start, which paths they may edit, which checks they must run, and which human docs govern the change.
2. Demonstrate a cacheable documentation-index task and a freshness gate in the Turbo pipeline.
3. Provide a small, copyable starting point for teams using coding agents in a pnpm monorepo.

Non-goals

1. Not an AI framework, chat application, or model-provider example.
2. Not a replacement for human documentation or repository contribution rules.
3. No hosted service, API key, remote code execution, or generated source changes.

Background

A root-level agent instruction file is useful, but it becomes broad in a monorepo and cannot reliably express package ownership, edit boundaries, package-specific checks, and the matching human documentation. Doc Bridge turns those repository facts into deterministic handoffs and fails CI when the index or documentation links become stale.

The existing with-mcp-servers example teaches how to structure and build MCP tool servers. This proposal covers a different problem: routing an agent safely through an existing monorepo before it edits code.

Proposal

Add examples/with-doc-bridge, starting from basic with the smallest changes needed:

• package-scoped agent docs for the example apps and shared package
• a Doc Bridge config using pnpm workspace discovery
• ak-docs:index as a cacheable Turbo task with explicit inputs and outputs
• ak-docs:gate to verify freshness and documentation coverage
• one command that resolves a package handoff and prints startHere, editRoots, checks, and the linked human guide

The demo would show the index caching normally, invalidating when a package document changes, and the gate rejecting stale repository context. @agentskit/doc-bridge is public, MIT-licensed, and does not require an inference provider.

I maintain Doc Bridge and can contribute and maintain the example if this scope is useful.