Find your next thread

Service documentation · v0.11.0

Keep the explanation.
Keep the source close.

Give your team service explanations, internal-flow diagrams and linked decision tables, with supporting source close at hand. When the code changes, see which parts need another look.

A curious cat following a bright blue thread of yarn
An explanation you can come back to

From service map to source code.

clew docs maintains a separate documentation repository: a service overview, a page per service and named interaction scenarios. Your agent authors the narrative; Codeclew keeps it connected to the selected source.

Read the story

Follow an operation through a plain-language explanation, a sequence diagram and its contract details.

Open the evidence

Select a diagram step to inspect retained source. Declared service connections stay distinguishable from compiler facts.

Check what changed

Freshness checks flag changes to registered source and contracts. Conservative source profiles can also flag formatting-only edits.

Render an offline HTML site or use the JSON, Markdown and Mermaid output. Keep manual notes outside generated output; refresh affected explanations after review.

Released scope · v0.11.0

Start locally with one service.

Document committed Python, Java or Kotlin source even when the application cannot build. Register its source scope, capture evidence, and ask your agent to explain responsibilities, entities, inputs, outputs and failure cases. Optional compiler facts enrich the same documentation.

Keep services, scenarios and entity dataflows in a separate documentation repository. The offline reader includes source references, interface cards, declared OpenAPI contracts, protected notes, publication history and visible gaps. Source freshness and meaning review are separate: local publication can remain UNASSESSED.

Download v0.11.0 ↗ · Local setup and authoring guide ↗

The local workflow needs no model gateway or GitLab runner. Your chosen agent's model and data settings still apply. Declared relationships do not prove deployed connections. GitLab integration and the 40-service workload remain deferred.
Native visuals · v0.11.0

Show what happens inside the service.

Ask your agent to explain a selected internal process from retained evidence. Publish its flow and decision tables alongside the service's responsibilities or an operation's explanation. The generated reader renders these local assets directly; no separate atlas or diagram CDN is required.

Follow the flow

Source-linked nodes and arrows explain supported action order and branch conditions. A dependency map shows structural relationships and does not imply execution order.

Understand a decision

A table links to the flow node it explains. FIRST means the first matching row wins. Unsupported links and unknown rule policies remain explicit instead of becoming invented connections.

Retain the evidence

Visuals share their containing explanation's saved version, freshness and meaning review. A source change can flag them for another look without automatically rerunning a model.

This is an authoring workflow over saved evidence, not automatic discovery of every business process. Selected flows do not establish complete service coverage or runtime behavior. Decision tables document source interpretation; they are not executable DMN.

Author a flow and linked decision table ↗ · Release scope and qualification status →

Included from the first command

A fresh repository already has help.

Run clew docs init --root ./architecture --title "Service documentation". Open architecture/docs/help.html for Codeclew setup, agent prompts, notes, scenarios and dataflows, or architecture/docs/runbooks.html for Codeclew operational procedures. Both guides work offline and exist before you register the first service.

New publications share navigation, the Codeclew favicon and the blue and cream reader theme. Service-specific runbooks come from your source and owner knowledge. Older publication URLs retain their original immutable pages.

The top-level clew --help now lists skill; use clew skill install --agent codex to install the bundled agent instructions. To move existing documentation, preserve its current-format saved state and first inspect the retained snapshot. Bind source checkouts with clew docs bind when a source check is needed; use clew docs check --service SERVICE_ID for the selected service. Reading or publishing saved evidence does not require a new capture.

RETURNED_INPUT_DIGEST in command examples means the complete inputDigest returned by the preceding list or show command, including sha256:. It protects a catalogue update against concurrent changes.

See what compiler analysis added

In a service page, open Coverage and evidence → Analysis evidence. Inspect the provider status, mapped declaration count and example semantic facts. For Kotlin 2.3 projects, install the optional kotlin23 pack and configure an admitted semantic profile. K2 can add resolved identities, types, nullability and JVM signatures; syntax-only pages explicitly show that the provider was not requested. Compiler facts do not establish deployed connections or reviewed business meaning.

Keep what your team knows

Add a note to the thing it explains.

Ask your agent to attach your original Markdown note to a service, one of its standard sections, a scenario, an entity definition or a dataflow. One note can address several objects. Preserve the original wording and keep the evidence-based answer separate.

Example note targets
ScopeTarget
Whole serviceservice:orders
Inputs and entry pointsservice:orders/section-ingress
Scenarioscenario:reservation-lifecycle
Entity definitionentity:reservation
Dataflowview:stock-quantity

For example: “Attach this question to entity:reservation: Does TTL still apply after confirmation? Preserve my wording, investigate the registered source, and document the answer with evidence and remaining uncertainties.”

Notes use Markdown and typed associations; the reader has no comment composer or discussion threads in 0.11.0. For a specific method or paragraph, use a section target and identify the exact subject in the note. That text is a focus hint, not a validated source anchor.

Agent prompts, detail preferences and examples ↗

Historical interactive example

Try following a claim to its source.

The example below documents Codeclew's own change workflow at revision 6281138. Select a step, then switch to Evidence for the supporting fragment. It illustrates source-linked reading; it is an earlier hand-built example, not output from the v0.5.0 service-documentation renderer.

Detail level
Machine-readable claims →
ScenarioFrom intent to a safely published change
DOT view
Why this format matters

Documentation remains useful when confidence is local.

A reader can inspect each statement independently. A released contract, a syntax observation, a compiler fact and an unresolved obligation do not inherit one another's confidence merely because they appear in the same graph.

Explore the historical studies →
Read the PDF study →