Skip to content

Phase 7: documentation and first contact - #58

Merged
adolgert merged 4 commits into
feature/phase6-featuresfrom
feature/phase7-docs
Oct 3, 2026
Merged

adolgert merged 4 commits into
feature/phase6-featuresfrom
feature/phase7-docs

Conversation

@adolgert

Copy link
Copy Markdown
Owner

Phase 7 of design/20260926_implementation_plan.md, stacked on #57. Review note: design/phase7_review.md.

  • README and home page lead with the promise, the decision table (with three "use something else" rows), the solver example with its printed output, and the promises in the contract's terms.
  • Manual: a tutorial in five levels, nine how-to guides by job, explanation pages (values and oracles, interaction coverage and the evidence with live numbers, constraints, engines with measured figures), a reference organized by purpose where every exported docstring opens "Use when …", a 0.4 → 0.5 migration table with executed "after" code, developer pages, and a one-pager for AI agents. Every example on every page is executed at build time.
  • Doctests run in the docs build and in the test suite; the build fails on any warning (warnonly = false, checkdocs = :exports).
  • Source changes made for the docs: Invalid.value documented, a clear message for <: inside rule macros, diagnose wording no longer overlaps the followups status, plural and article agreement in printed counts, and the lockfile pattern keeps two checks.

Docs build clean; full suite 310,435 pass, 0 failures.

🤖 Generated with Claude Code

adolgert and others added 4 commits September 27, 2026 21:15
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
README and home page lead with the promise, the decision table, and one
example with its printed output. The manual is a tutorial in five levels,
nine how-to guides by job, explanation pages on values and oracles,
interaction coverage and its evidence, constraints, and the engines, a
reference organized by purpose with every exported docstring opening on
the situation it serves, a 0.4 to 0.5 migration table, developer pages,
and a one-pager for AI agents. Doctests run in the docs build and in the
test suite; the build fails on any warning.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
wording, two-check lockfile pattern, badge and contract wording

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@adolgert
adolgert merged commit 7115957 into feature/phase6-features Oct 3, 2026
14 checks passed
@adolgert
adolgert deleted the feature/phase7-docs branch October 3, 2026 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant