Refactor/framing pass - #46
Merged
Merged
Conversation
This was referenced Oct 4, 2026
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.
Overview
The canon now says where each part of a header starts and ends, and what the reader does with a line it cannot place. Until now it said only that indentation is significant. The rules it adds are the ones
living-doc-utilitiesreads by, from its framing pass and its line accounting (living-doc-utilities#183,P35-UT10). The two must not diverge.docs/guides/living-doc-header-types.md§ Indentation gets a new block, Where a part starts and ends:key:any deeper is content, never a new key.AC:header, at a key at the key level, or at a# =====rule. A rule inside the header is an optional end of a block, and the last rule ends the header. So anotes:written after the criteria is the entity's note, no longer dropped..featureheader everyAC:line sits at the same indent, the first one's (template: 2). AnAC:line elsewhere is text, and it is reported.#,*). A line with text and no marker inside a header is not read and is reported as an error. Gherkin rejects such a line aboveFeature:anyway.acceptance_criteria:last. It is a recommendation only, because indentation decides.The level table marks that every criterion header sits at one level. The cross-reference header gains an optional
notesfield: notes about that page, kept with the page and its data and never merged into the parent Feature's notes. A cross-reference page is a part of its Feature with data of its own (route, owners, purpose, functionalities, now notes).No example file changes.
tools/examples_check.pyand its tests pass unchanged.Release Notes
# =====rule as an optional end of a block.notes:about its own page; they stay with the page.Framework
docs/introduction/principles.mdin this PRF1 (entities and their header formats): the header format gains rules on where its parts start and end. No other row changes.