Skip to content

feat: read the catalogue from each project's own record - #67

Merged
kieronlanning merged 1 commit into
mainfrom
feat/project-owned-catalogue-records
Nov 15, 2026
Merged

kieronlanning merged 1 commit into
mainfrom
feat/project-owned-catalogue-records

Conversation

@kieronlanning

Copy link
Copy Markdown
Contributor

The catalogue record for a project now lives in that project's own repository, at .config/purview-docs.yml, and the site reads it at build time from the default branch (ADR 0013, added here).

Why: every entry under src/src/data/projects/ was written here, by this repository, for projects that live elsewhere and move without asking. That is a drift engine with no detector — zodsharp's record still listed net8.0 and net9.0 two releases after the project dropped them — and correcting any of it meant a cross-repository pull request, which is exactly the friction that makes a record stale.

What changes:

  • Discovery is the organisation's repository list. sync-manifests lists purview-dev's repositories and reads .config/purview-docs.yml from each; a 404 means "not a catalogue project". Joining the catalogue is one file in the project's repository and no pull request here.
  • The 18 records that lived here are deleted. Each was published to its project repository first, in its own pull request — the 18 links are in the commit body below.
  • The same cache and fixture model as the release data. src/.cache/manifests/manifests.json (gitignored) with src/fixtures/manifests/index.json as the committed offline snapshot; DATA_MODE selects live/auto/cache/fixture, so rendering never performs network I/O.
  • A project's record wins over a local file with the same id, and the leftover copy is reported by just check-projects rather than silently ignored — the migration path for the rest of the catalogue.
  • Validation failures name the owner: projects[zodsharp] (purview-dev/zodsharp (.config/purview-docs.yml at main)).

Evidence (all run against the live manifests):

  • bun test tests/unit — 362 pass, 0 fail (was 356; 6 new tests for the manifest cache and the loader).
  • just check-projects — passed: 18 projects, 1 collaboration.
  • bun run lint, bun run format:check — clean.
  • Manifests synced: 18 project-owned record(s) from 19 repositories.
  • src/src/data/projects/ is gone entirely (git does not keep an empty directory), and the catalogue still resolves in full — offline from the fixture, live from the projects.

Follow-up worth knowing: the site repository's canonical name is purview-dev/purview-dev.github.io; purview-dev/purview-dev is a rename alias. The new manifests name the canonical one, and this repository's own docs still use the alias in prose.

@kieronlanning
kieronlanning enabled auto-merge (squash) November 15, 2026 10:10
The record for a project now lives in that project's repository at
.config/purview-docs.yml, and the site reads it at build time from the default
branch. A project owns its own words and pointers, so the record changes in the
same pull request as the thing it describes instead of drifting in a second
repository: zodsharp's record still listed net8.0 and net9.0 two releases after
the project dropped them.

- Discovery is the organisation's repository list: a repository that publishes the
  file is a catalogue project, so joining the catalogue needs no pull request here.
- The 18 records that lived here are deleted, each having been published to its
  project repository first.
- Fetched records are cached under src/.cache/manifests and snapshotted into
  src/fixtures/manifests, so rendering never performs network I/O and an offline
  build still resolves the whole catalogue.
- A record a project owns wins over a local file with the same id, and the leftover
  copy is reported by `just check-projects` so it gets deleted.
- ADR 0013 records the decision and its consequences.
@kieronlanning
kieronlanning force-pushed the feat/project-owned-catalogue-records branch from 3c92dfe to 7cdb522 Compare November 15, 2026 10:12
@kieronlanning
kieronlanning merged commit 343eae5 into main Nov 15, 2026
1 check passed
@kieronlanning
kieronlanning deleted the feat/project-owned-catalogue-records branch November 15, 2026 10:17
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