From 1fc282f796a199651d4ce7c284cb6eb726925b12 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Mon, 1 Jun 2026 21:49:14 +0000 Subject: [PATCH] Clarify documentation policy and publish docs --- docs/internal/publish.md | 2 +- docs/policy/documentation.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/internal/publish.md b/docs/internal/publish.md index 9e306da..dc7f5e0 100644 --- a/docs/internal/publish.md +++ b/docs/internal/publish.md @@ -22,7 +22,7 @@ Execution fails if a write, delete, state serialization, or context check fails. ## Boundaries -The current implementation publishes source files and Markdown-to-HTML outputs. Markdown sidecar mode writes same-directory `.html` outputs, and Markdown index mode writes `index.html`. Backend behavior is supplied through `internal/storage`; app runtime currently supplies local, SSH, and S3 backends. +The package publishes source files and Markdown-to-HTML outputs. Markdown sidecar mode writes same-directory `.html` outputs, and Markdown index mode writes `index.html`. Backend behavior is supplied through `internal/storage`; app runtime supplies local, SSH, and S3 backends. The package uses `internal/state` for destination comparison, `internal/storage` for IO, and the shared `internal/config` publish/transform policy helper for request validation. It resolves transforms through a narrow resolver supplied by the caller; concrete transform registration is owned by the app layer. It does not parse CLI flags, load config files, or choose which source bundles a destination receives. diff --git a/docs/policy/documentation.md b/docs/policy/documentation.md index d9ed7fa..fd3da04 100644 --- a/docs/policy/documentation.md +++ b/docs/policy/documentation.md @@ -106,7 +106,7 @@ Recommended: - `examples/` - `docs/policy/development.md` -### Modular, staged, service-oriented, or orchestration application +### Modular, service-oriented, or orchestration application Required: - `docs/cli.md`, if CLI-based @@ -175,7 +175,7 @@ It should include: - dependency policy; - how to add config fields; - how to add CLI flags; -- how to add stages/modules/adapters, if applicable; +- how to add modules or adapters, if applicable; - how to update examples; - documentation update expectations. @@ -216,7 +216,7 @@ Explain when commands are useful, not just their syntax. **Audience:** administrators, operators -Required for applications that maintain state, support resume behavior, run multiple stages, write durable artifacts, use remote storage, or require recovery procedures. +Required for applications that maintain state, support resume behavior, run multi-step workflows, write durable artifacts, use remote storage, or require recovery procedures. It should cover: @@ -248,7 +248,7 @@ Each entry should include: **Audience:** developers, LLM coding agents -Required for modular, staged, service-oriented, or orchestration projects. +Required for modular, service-oriented, or orchestration projects. This directory describes implemented internal components. It is not the roadmap.