Skip to content

docs: name the metamodels each coursework task covers - #124

Merged
ExtraToast merged 1 commit into
mainfrom
docs/56-rebase-proposal
Sep 15, 2026
Merged

ExtraToast merged 1 commit into
mainfrom
docs/56-rebase-proposal

Conversation

@ExtraToast

Copy link
Copy Markdown
Contributor

Part of #56.

What this changes

The coursework README's task table now names the metamodels each task covers: Task 1 defines Project Intent as the source and Resolved Deployment as the target, Task 2 transforms Project Intent, resolved against the Platform document, into Resolved Deployment, and Task 3 generates the Deliverable Set from Resolved Deployment. That matches the scope table in emf/docs/architecture.md.

What is left of #56, and why it is not here

Most of the ticket was overtaken by #101, #102 and #103, which rewrote the proposal around the two implementations.

Item State
Listings match the auth example, checked in CI No longer applicable: #101 removed the appendix and every listing, so there is nothing to compare
Metamodels section Done by #102 and #103
Tooling and evidence Done by #101 and #103
Coursework README task table Done here
Delivery architecture Still needed, in the proposal
Output layout Still needed, in the proposal
Platform data Still needed, in the proposal

The three still needed all live in the Overleaf-mirrored proposal, and the mirror is never hand-edited, so they are an Overleaf edit followed by a re-mirror rather than part of this pull request:

  • 02-solution.tex says release CI applies the resources with kubectl apply -k. Delivery is defined separately from the model (docs/adr/deferred/README.md).
  • 02-solution.tex lists "the alert catalogue" as platform data. The Platform document carries no rule catalogue (spec/v1/14-platform-intent.md#monitor-cadence).
  • 04-generated-code.tex says one Deliverable Set per application and one Kustomize entry point. The six central adapters run once over the composed union and produce one tree for the estate (spec/v1/30-deliverables.md).

Verification

  • npm run lint:links: 186 files clean.
  • npm run lint:meaning: 165 files clean.
  • npm run verify exit 0: 722 tests, coverage unchanged.

The task table only described each report by subject, not by which of
the two metamodels its task delivers. Name Project Intent and Resolved
Deployment per task, matching emf/docs/architecture.md's task table and
the two-metamodel shape #102 and #103 settled on.
@ExtraToast ExtraToast added type: docs Documentation-only change. area: tooling Reusable workflows, Gradle, templates, Renovate, and API tooling. component: docs Runbook, README, API docs, or documentation tooling. labels Sep 15, 2026
@github-actions

Copy link
Copy Markdown

Shape

bucket files additions deletions
documentation 1 +3 -3

Coverage

Baseline: main @ 2714a7c.

metric this branch main diff
statements 99.17% 99.17% 0.00
branches 96.56% 96.56% 0.00
functions 100.00% 100.00% 0.00
lines 99.10% 99.10% 0.00

This pull request changed no covered line.

@ExtraToast
ExtraToast merged commit e152c78 into main Sep 15, 2026
23 checks passed
@ExtraToast
ExtraToast deleted the docs/56-rebase-proposal branch September 15, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: tooling Reusable workflows, Gradle, templates, Renovate, and API tooling. component: docs Runbook, README, API docs, or documentation tooling. type: docs Documentation-only change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant