docs: lifecycle stages, report scope, and status references by name - #9
Open
delchev wants to merge 1 commit into
Open
docs: lifecycle stages, report scope, and status references by name#9delchev wants to merge 1 commit into
delchev wants to merge 1 commit into
Conversation
Renders the specification change proposed in IntentFile/intent-specification#6: - data: a `stage` section on seeds (the draft/live/cancelled/void vocabulary, why the meaning belongs with the nomenclature, the metadata-not-a-column and collision rules) plus a "Status references — name, not number" section for every site that names a status. - presentation: a "Lifecycle scope" section on reports - the shapes, and the normative rules for the implicit `live` default, the two conditions that stand it down (a status dimension, an authored status filter), and the diagnostic a generator must report when nothing is resolvable. - reference: a `scope` row, the snippets updated to show `stage:`, `scope:` and symbolic statuses, and the cross-model boundary under Planned.
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.
Renders the specification change proposed in IntentFile/intent-specification#6 (implemented in the reference implementation as eclipse-dirigible/dirigible#6647, for eclipse-dirigible/dirigible#6645).
Why: an aggregation over an entity that carries a lifecycle is wrong by default — drafts nobody has issued, cancelled and voided documents all land in the sum unless the author remembers a predicate over positional status ids, and nothing in the format said so. The addition declares a status's meaning once, where the nomenclature is seeded, and lets reports and guards resolve it.
What changed
spec/data— astagesection under seeds: thedraft | live | cancelled | voidvocabulary as a table, why the meaning belongs with the nomenclature rather than being re-derived in every predicate, and the normative rules (metadata never becomes a column; a classified row carries its primary key; a collidingstageproperty is reported, not guessed at). Plus Status references — name, not number, covering every site that names a status, with the positional-id argument spelled out.spec/presentation— a Lifecycle scope section under reports: the three shapes (implicitlive,scope: all, an explicit stage), and the normative rules for when the implicit default applies, the two conditions that stand it down (a status dimension, an authored status filter), and the diagnostic a conforming generator must report when nothing is resolvable.reference— ascoperow; the reports, transitions and seeds snippets updated to showscope:, symbolic statuses andstage:; the cross-model boundary added under Planned.Left open for maintainer review — the specification PR governs the wording, and this only renders it.
vitepress buildis clean and the three new anchors resolve (#lifecycle-scope,#stage-what-a-status-means-to-the-lifecycle,#status-references-name-not-number).