Skip to content

docs: presentation & navigation for newcomers (Phase 4) - #237

Merged
DrMurphyIsIn merged 4 commits into
mainfrom
docs/phase4-presentation
Sep 6, 2026
Merged

docs: presentation & navigation for newcomers (Phase 4)#237
DrMurphyIsIn merged 4 commits into
mainfrom
docs/phase4-presentation

Conversation

@DrMurphyIsIn

Copy link
Copy Markdown
Owner

Phase 4 (presentation & navigation) of the public-release-prep effort. Makes the repo legible to a first-time mathematician/reviewer and gives Telperion the onboarding docs it lacked. No code or mathematics changed; all internal links verified to resolve.

README

  • CI status badges (proof-lean, proof-verify, telperion-lean-e2e) — the at-a-glance "the kernel check is green" signal a math reviewer looks for first.
  • A scannable TL;DR that states what this is, that the conjecture is not claimed proved, and routes the visitor to STATUS.md (proven-vs-open), the verify section, and Telperion getting-started.

New Telperion docs

  • telperion/docs/GETTING_STARTED.md — install → generate → and, crucially, verify the emitted Lean locally end-to-end (pinned leanprover/lean4:v4.32.0, lake exe cache get for the Mathlib cache, lake build). The audit flagged this local-verification path as the single biggest doc gap: generating .lean was documented; checking it was not.
  • telperion/docs/ARCHITECTURE.md — the untrusted-generator/trusted-kernel model, the certify → validate → emit → freeze pipeline, the emitter catalog, the self-verification layer, and the enforced engine vs. bg/ research-lab boundary (which test_core_boundary.py guards).
  • telperion/CONTRIBUTING.md — how to add a certificate shape, including the mandatory emitter-sensitivity stance (the gate that caught the unclassified emitters in Phase 0), the manifest entry, and the CI gates.
  • telperion/README.md — a "New to Telperion?" pointer to the three docs above.

Notes

🤖 Generated with Claude Code

- README: add CI status badges (proof-lean, proof-verify, telperion-lean-e2e)
  and a scannable TL;DR that routes a first-time visitor to STATUS.md
  (proven-vs-open), the verify section, and Telperion getting-started.
- telperion/docs/GETTING_STARTED.md (new): install -> generate -> and, crucially,
  VERIFY the emitted Lean locally end-to-end (pinned leanprover/lean4:v4.32.0 +
  'lake exe cache get' Mathlib cache + 'lake build') -- the audit's #1 doc gap.
- telperion/docs/ARCHITECTURE.md (new): the untrusted-generator/trusted-kernel
  model, the certify->validate->emit->freeze pipeline, the emitter catalog, the
  self-verification layer, and the enforced engine vs bg/ research-lab boundary.
- telperion/CONTRIBUTING.md (new): how to add a certificate shape, incl. the
  mandatory emitter-sensitivity stance, the manifest entry, and the CI gates.
- telperion/README.md: a 'New to Telperion?' pointer to the three docs above.

No code or mathematics changed. All internal links verified to resolve.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W4CnMPKEstq3yVjTgjtreY
@DrMurphyIsIn
DrMurphyIsIn merged commit 158f213 into main Sep 6, 2026
0 of 14 checks passed
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