Skip to content

docs(openspec): add ADR-001 information architecture#1701

Merged
rubenvdlinde merged 1 commit into
mainfrom
chore/ia-adr
May 23, 2026
Merged

docs(openspec): add ADR-001 information architecture#1701
rubenvdlinde merged 1 commit into
mainfrom
chore/ia-adr

Conversation

@rubenvdlinde
Copy link
Copy Markdown
Contributor

Summary

Adds the first per-app architecture ADR for openregister, codifying the information architecture that places all 114 specs onto a stable 8-item top-level menu without inflating it as new capabilities ship.

Distilled from the cross-app brief at /tmp/ia-mydash-openregister.md (openregister section). The sibling mydash ADR is being authored in parallel; both apps follow the same discipline of "menu items are destinations, not features."

Top-level navigation (fixed at 8)

Registers / Schemas / Objects / Integrations / Audit / Workflows / Beheer / API & Docs. The AI chat companion is a global launcher (sidebar pill), not a menu item.

The 5 rules

  1. Menu items are data primitives, not features — ABAC, NLX, OpenLineage, PII, CDC, NORA are capabilities of primitives, never menu items.
  2. Cross-cutting governance lives in Beheer, organised by topic — exactly 8 tabs (Tenants, Auth, Policies, Environments, Data, Compliance, Observability, System); new governance specs join an existing tab.
  3. Every primitive gets a consistent tab template — Registers/Schemas/Objects detail pages have fixed tab orders so the layout is learned once.
  4. Specs that affect both an instance and an org-level policy appear in both places — per-register tab edits the instance; Beheer sets defaults.
  5. Developer surface (API & Docs) is its own menu, separate from Beheer (platform-ops) — different audiences, different artefacts.

Test plan

  • ADR file present at openspec/architecture/adr-001-information-architecture.md
  • Rules numbered with Rationale + How-to-apply for each
  • Future spec proposals reference this ADR for placement decisions

Codifies the 8-item top-level navigation (Registers, Schemas, Objects,
Integrations, Audit, Workflows, Beheer, API & Docs) and 5 placement rules
that keep new specs from inflating the menu. Distilled from the
cross-app information-architecture brief covering all 114 openregister
specs; sibling to the mydash ADR being authored in parallel.
@github-actions
Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/openregister @ 94b8a90

Check PHP Vue Security License Tests
lint
phpcs
phpmd
psalm
phpstan
phpmetrics
eslint
stylelint
composer ✅ 147/147
npm ✅ 525/525
PHPUnit ⏭️
Newman ⏭️
Playwright ⏭️

Quality workflow — 2026-05-23 05:39 UTC

Download the full PDF report from the workflow artifacts.

@rubenvdlinde rubenvdlinde merged commit eda7549 into main May 23, 2026
20 of 24 checks passed
@rubenvdlinde rubenvdlinde deleted the chore/ia-adr branch May 23, 2026 05:44
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