Public documentation v0.1.0
Docs deployment target
Environment-variable contract for deployed public docs updates.
Contract
Profile distributions declare installer or user-required environment variables in distribution.yaml under env_requires. .env files are user-owned runtime state, so profile distribution installs and updates must not overwrite them. Public .env.EXAMPLE files or install guidance should show expected variable names and non-secret example values when a profile needs user configuration. PM and docs profiles use SOFTWARE_FACTORY_DOCS_SPRITE_NAME to identify the dedicated Software Factory docs sprite for publication.
Example target
The current non-secret public example is SOFTWARE_FACTORY_DOCS_SPRITE_NAME=hermes-sf-docs. The variable name and the docs sprite name are safe to mention; private .env contents and credentials are not.
PM behavior
PM profiles create deployed-docs tasks only when a docs target is available from an explicit release handoff or from SOFTWARE_FACTORY_DOCS_SPRITE_NAME. When PM asks the docs profile to publish, the handoff includes the non-secret target name or states that docs must resolve it from the installed environment. PM should not ask docs workers to guess a sprite name.
Docs behavior
Docs profiles publish or update only the dedicated docs sprite named by the explicit handoff or by SOFTWARE_FACTORY_DOCS_SPRITE_NAME. If deployed docs are expected but no explicit target and no non-empty environment variable are available, the docs profile blocks or skips publication with a clear non-secret explanation instead of guessing.
Checkpoint discipline
When a docs sprite is mutated, docs creates a pre-change checkpoint, updates only the dedicated docs site, verifies the deployed public page, then creates a post-change checkpoint.
Public/private boundary
Public docs may mention the variable name and non-secret docs sprite name. They must not publish private .env contents, credentials, local profile state, memories, sessions, Kanban databases or workspaces, logs, private sprite URLs, checkpoint internals, or unrelated environment values.