Repository navigation
docs: add a five-minute GAP explainer - #23
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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: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 typecheckpnpm docs:buildDOCS_BASE_URL=/governed-artifact-protocol/ pnpm docs:build🤖 Generated with Claude Code