Skip to content

docs: add a five-minute GAP explainer - #23

Merged
aharvard merged 2 commits into
mainfrom
claude/gap-protocol-simplify-8e8634
Oct 22, 2026
Merged

aharvard merged 2 commits into
mainfrom
claude/gap-protocol-simplify-8e8634

Conversation

@aharvard

Copy link
Copy Markdown
Collaborator

Problem

GAP's intro pages are accurate but dense. A new reader meets profiles, ratification, authorization, approvals, rejections, withdrawal, dependency sets, and signatures at roughly equal weight, which makes the core hard to see. The lifecycle can also read as a state machine (draft → released → withdrawn), although GAP never changes a record; it adds new ones.

Changes

  • Add GAP in five minutes (documentation/docs/intro/gap-in-five-minutes.md), placed after the Intro index in the sidebar. It builds up in layers, each complete on its own:
    • one sentence: a receipt showing this exact content, under this exact approved template, was released by someone allowed to release it;
    • five words: profile, version, authority, release, proof;
    • four rules: nothing is edited; every decision names exactly what it covers; only an authority can decide; the receiver can check the proof;
    • one move made twice: propose, then approve, once for the profile (ratification) and once for the content (authorization), mapped to the six lifecycle steps;
    • optional parts grouped apart from the core: approvals and rejections, withdrawal, dependencies, signatures;
    • records are added, never changed;
    • a software-release comparison (commit, signed tag, lockfile, yank), labeled as comparison rather than equivalence, with a pointer to Related work;
    • what a valid proof does not establish.
  • Register the page's route and sidebar position in documentation/test/site-structure.test.ts.

This is a documentation-only change. It adds no protocol requirements and changes no schemas, digest domains, examples, or demo behavior.

Open question

The new page overlaps the Intro index and "What is GAP?". If it reads well, a follow-up could make it the Intro landing page or merge it with "What is GAP?" so there are fewer overview pages.

Verification

  • pnpm docs:test (19/19 pass)
  • pnpm --dir documentation typecheck
  • pnpm docs:build
  • DOCS_BASE_URL=/governed-artifact-protocol/ pnpm docs:build

🤖 Generated with Claude Code

aharvard and others added 2 commits October 22, 2026 06:52
Distill the protocol into one sentence, four rules, and one
propose/approve move made twice, so a new reader can grasp the core
before meeting the full vocabulary. Optional parts are grouped
separately, and decisions are described as added records, not state
changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The site-structure test pins every page's route and the sidebar order,
so the new Intro page needs an entry in both.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@aharvard
aharvard requested a review from daveh-beep as a code owner October 22, 2026 10:58
@aharvard
aharvard merged commit 1240c6f into main Oct 22, 2026
5 checks passed
@aharvard
aharvard deleted the claude/gap-protocol-simplify-8e8634 branch October 22, 2026 11: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