Living Technical Docs

Generate the docs site your system actually needs

Give Inspectcat the main repository, the pages your team wants to maintain, and the related repositories the system depends on. The goal is documentation that is useful to engineers and usable as agent context.

Repo

primary source context

Pages

documentation scope

Links

connected repositories

Docs site workflow

Primary repo + pages + connected repos

Primary repository selected

Ready

Documentation pages defined

Ready

Connected service repos mapped

Needs review

Generated docs site

Needs review

Agent-readable context

Needs review

Product direction: generated docs grounded in the system graph

The docs gap

Teams know which docs they need, but the system context is spread across repos

A useful docs site has to explain the main codebase, the pages teams expect to maintain, and the service boundaries hidden in other repositories.

The source of truth starts in one repository

Teams need to point Inspectcat at the main repo that owns the product surface and implementation context.

Docs scope should be explicit

Instead of generating everything, teams should define the pages they expect to keep useful over time.

Systems cross repository boundaries

A page about billing, auth, or data flow may need context from services reached over HTTP or other internal interfaces.

Capabilities

Built around the signals Inspectcat can actually observe

Start from a primary repository

Use the main repo as the root context for the generated documentation site.

  • Repository structure, commands, and implementation context
  • Existing README, AGENTS.md, and architecture notes
  • Code paths connected to requested documentation pages

Define the pages to maintain

Teams provide the documentation pages they care about, so generation is scoped to useful product and engineering context.

  • Page list as product documentation scope
  • Human-readable docs shaped for engineers
  • Agent-readable context for future AI work

Map connected repositories

Add the repositories that the main system calls into, so generated docs can explain cross-service behavior.

  • HTTP and service dependency context
  • Cross-repository data flow explanations
  • A docs site grounded in the real system graph

Next step

Turn repository context into a maintained documentation site

Inspectcat is moving toward generated docs that explain the primary repository, the pages teams maintain, and the connected repositories agents need to understand.