Scoria.AdopterDocContract (scoria v0.1.0)

Copy Markdown View Source

Single source of truth for adopter-facing README and support-doc contracts.

Exports capability nouns, upgrade-safe install markers, and refute patterns for milestone banner language and maintainer-only commands. Maintainer CI commands belong in the operator guide, not in adopter README assertions.

Summary

Functions

Milestone banner phrases README must not contain.

Maintainer-only Mix commands that must not appear in README body copy.

Capability nouns that adopter README and support docs must mention.

Exact upgrade-safe install command markers for README Install guidance.

Functions

milestone_banner_refutes()

Milestone banner phrases README must not contain.

readme_maintainer_command_refutes()

Maintainer-only Mix commands that must not appear in README body copy.

shipped_capability_nouns()

Capability nouns that adopter README and support docs must mention.

upgrade_safe_install_markers()

Exact upgrade-safe install command markers for README Install guidance.