Documentation workflow

Keep Ownfold implementation, security decisions, public APIs, and integration guidance synchronized as each development phase completes.

Documentation is a completion requirement for every Ownfold phase. A feature is not complete until its public behavior, security boundary, persisted-format impact, integration path, and failure modes are documented where relevant.

Definition of done

For each phase:

Update the product or integration guide with the supported developer workflow.
Add or revise an ADR before changing cryptographic primitives, key storage, serialization, or package boundaries.
Update the threat model when trust boundaries, metadata exposure, or attacker capabilities change.
Update the persisted-format specification before changing stored data.
Update the roadmap with implemented work and explicitly remaining production work.
Run the complete docs verification command.

pnpm docs:verify

The command performs a strict static build, validates internal links, and audits the generated site. CI runs the same check through pnpm verify.

Local development

Start the documentation server with hot reload:

pnpm docs:dev

Build and preview the static production output:

pnpm docs:build
pnpm docs:preview

The generated site uses bundled local search and emits raw Markdown, llms.txt, agent-readability.json, and the discoverable Ownfold integration skill. WebMCP exposes read-only documentation tools in compatible browsers. It does not enable a hosted search provider, Ask AI endpoint, MCP server, analytics, or other runtime service. See AI and agent access.

Writing rules

State current behavior separately from planned behavior.
Never imply that browser E2EE protects against malicious JavaScript or a compromised device.
Never document a plaintext server fallback.
Include actionable recovery behavior for errors and irreversible lifecycle actions.
Use the exact public package names and exported APIs from the repository.
Keep code examples type-safe and use extensionless package imports.