Skip to content

docs(fork): a machine-readable header on every carried-change file - #478

Merged
QuentinBisson merged 6 commits into
giantswarmfrom
docs/ledger-header
Oct 19, 2026
Merged

QuentinBisson merged 6 commits into
giantswarmfrom
docs/ledger-header

Conversation

@QuentinBisson

Copy link
Copy Markdown

Problem

The ledger files are prose, so nothing can read the Upstream state of a carried change without a person: a keyword pass over the agentgateway ledger agreed with a human reading on 11 of 20 files. giantswarm/kagent-upstream#719 proposes a machine-readable header on every file.

Change

Every fork/*.md gets a YAML front-matter (id, fork, theme, category, status, upstream outcome/refs/exit, depends_on, commit, verified) seeded from the prose and reviewed by hand; the prose stays as it is, and the Status and Upstream bullets stay beside the header until agent-substrate#719 settles whether they go. Cross-line depends_on entries name the counterpart file in the other ledgers. FORK.md describes the fields. Stacked on #477.

Signed-off-by: QuentinBisson <quentin@giantswarm.io>
Every file under fork/ opens with the YAML front-matter proposed in giantswarm/kagent-upstream#719 (id, fork, theme, category, status, upstream outcome/refs/exit, depends_on, commit, verified), seeded from the prose and the 2026-10-19 review; the prose is unchanged. FORK.md describes the fields.

Signed-off-by: QuentinBisson <quentin@giantswarm.io>
…eaders

Signed-off-by: QuentinBisson <quentin@giantswarm.io>
Signed-off-by: QuentinBisson <quentin@giantswarm.io>
The fork-ledger workflow runs .github/scripts/ledger-header.sh on fork/ with its fixture test, the same rules as fork-ledger validate (giantswarm/kagent-upstream#719).

Signed-off-by: QuentinBisson <quentin@giantswarm.io>
@QuentinBisson
QuentinBisson marked this pull request as ready for review October 19, 2026 12:04
@QuentinBisson
QuentinBisson requested a review from a team as a code owner October 19, 2026 12:04
Base automatically changed from docs/ledger-20261019 to giantswarm October 19, 2026 12:04
@QuentinBisson
QuentinBisson merged commit c8e0cc2 into giantswarm Oct 19, 2026
20 checks passed
@QuentinBisson
QuentinBisson deleted the docs/ledger-header branch October 19, 2026 12:23
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