Skip to content

Commit 0d83ee8

Browse files
docs(ui): cut ROADMAP.md to a pointer, delete the console-streamlining summary, rename the app-shell extraction guide (#26023)
<!-- claude-projects-attribution: {"github_login":"os-elon-musk"} --> _Requested by **Elon** · [project thread](https://claude.ai/code/project/chan_01WedDzV26nniwxv7jC88B9D?thread=cmsg_01WedDzV26nniwxv7jC88B9D8qAi6V5b7pkuny9oUKDyVw)_ Part of #25919. This is PR 1 of the ruled workload (ruling 6407900763, item 3, housekeeping), minus the `ui/AGENTS.md` lines. #25919 remains open for PR 2, the `ui/AGENTS.md` restructure. ## What changed - `ui/ROADMAP.md`: 1,899 lines cut to a 20-line pointer file. The old text stopped at v3.3.2 (May 2026) and claimed 80 Storybook stories; there is no `.storybook` anywhere in the tree. The pointer names where plans live now: issues and their `area:*` / `priority:*` labels, milestones and `target:*`, the platform `ROADMAP.md` and `NORTH-STAR.md`, the changelogs, and the ADRs. It also states that ADR numbers are allocated in the ObjectStack repository's `docs/adr`. - `ui/docs/CONSOLE-STREAMLINING-SUMMARY.md`: deleted. It was a one-off session summary that duplicated the architecture guide. - `ui/docs/ARCHITECTURE.md` renamed to `ui/docs/app-shell-extraction-guide.md`, content unchanged. It is the 2026-04 app-shell extraction guide, not an architecture overview; the current overview is `content/docs/guide/architecture-overview.md`. Readers that follow the new name: the real-tree pin in `check-doc-snippet-types.test.ts`, the four `reads` entries in `markdown-test-inputs.mjs` (the deleted file's entries removed), and the `setup.sh` hint, which now points at the architecture overview. ## Acceptance notes - **`SCAN_ROOTS` row for `ROADMAP.md` kept, against the ruling's wording.** The ruling says to drop it, but `check-doc-links.test.ts` holds the invariant "scans EVERY tracked root-level markdown file". `ROADMAP.md` stays a tracked root file, so dropping its row would turn that test red. Keeping it is also the stricter reading: the pointer file's links stay checked. The row could only go if the file were deleted. - **`.github/prompts/`** is already absent under `ui/` on `main`. Nothing to delete. - **`ui/docs/adr/README.md` is not in this PR.** `ui/docs/adr/**` is on the governed surface, so it would make this PR Tier H and need contract review. It rides PR 2. The fact it would state, that ADR numbers come from objectstack, is in the pointer file meanwhile. - **Dependabot item dropped with a reading.** `ui/.github/dependabot.yml` is dead: GitHub reads only the repository-root `.github`. The live root config has a `github-actions` entry with no `groups:` key, and no test pins the `changesets/action` SHA (the card's `changeset-release-action-ref-pin.test.ts` does not exist on `main`). The collision the card describes cannot happen today. - **Left on purpose:** comments in `check-doc-expression-carriage.mjs` and its test that tell the history of `docs/ARCHITECTURE.md` (the ruling says existing comments are not swept), and the synthetic `docs/ARCHITECTURE.md` fixtures in `check-doc-links.test.ts`, which build their own tree. The published `ui/apps/console/README.md` still calls the roadmap "the Console phases and their status". It was not edited, because a shipped-file change would owe a changeset for the whole fixed group. - **No changeset (`skip-changeset`).** No package's `files[]` content changes: `ui/ROADMAP.md` and `ui/docs/**` belong to no package, and `ui/scripts/**` is private tooling. ## Verification (head 29ac985) - `pnpm exec vitest run` in `ui/` on `check-doc-links`, `check-doc-snippet-types`, `markdown-test-inputs`, `cross-file-line-citation-census` and `check-doc-expression-carriage` tests: Test Files 5 passed, Tests 377 passed (after `pnpm --filter @objectstack/spec build`, because the carriage test imports the built spec). - `node scripts/check-doc-links.mjs` (in `ui/`): exit 0, "Links are valid across 17 scan roots". - `node scripts/markdown-test-inputs.mjs --audit` (in `ui/`): exit 0, "114 candidate test files, all adjudicated; 80 declared entries, all present". - `dispatch-gates --commands` derived 22 commands; every one ran with exit 0. `--ran` reconciliation: 18 derived families accounted for, 0 NOT MEASURED. - `check-commit-card-trailers --range origin/main..HEAD`: pass. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01SvjM7dLb5MChvhDJnoGbHV --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 003104e commit 0d83ee8

6 files changed

Lines changed: 26 additions & 2176 deletions

File tree

‎ui/ROADMAP.md‎

Lines changed: 20 additions & 1899 deletions
Large diffs are not rendered by default.

‎ui/docs/CONSOLE-STREAMLINING-SUMMARY.md‎

Lines changed: 0 additions & 271 deletions
This file was deleted.
File renamed without changes.

‎ui/scripts/__tests__/check-doc-snippet-types.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@ describe('objectui#7856 — the root docs/*.md pages are in the scan set, and on
671671
const documents = listDocuments(repoRoot);
672672
for (const doc of rootDocsPages(repoRoot)) expect(documents).toContain(doc);
673673
// Non-vacuous: the leg reaches a real page, not an empty directory.
674-
expect(rootDocsPages(repoRoot)).toContain('docs/ARCHITECTURE.md');
674+
expect(rootDocsPages(repoRoot)).toContain('docs/app-shell-extraction-guide.md');
675675
});
676676

677677
it('the widening judges something — the leg contributes blocks to the compiled tier', () => {

‎ui/scripts/markdown-test-inputs.mjs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -855,19 +855,19 @@ export const ADJUDICATED = new Map([
855855
[
856856
'scripts/__tests__/check-doc-links.test.ts',
857857
{
858-
reads: ['./*', 'apps/**', 'content/docs/**', 'docs/ARCHITECTURE.md', 'docs/CONSOLE-STREAMLINING-SUMMARY.md', 'docs/adr/**', 'docs/audits/**', 'examples/**', 'packages/**'],
858+
reads: ['./*', 'apps/**', 'content/docs/**', 'docs/app-shell-extraction-guide.md', 'docs/adr/**', 'docs/audits/**', 'examples/**', 'packages/**'],
859859
},
860860
],
861861
[
862862
'scripts/__tests__/check-doc-snippet-emitted-census.test.ts',
863863
{
864-
reads: ['README.md', 'apps/console/docs/UI_IMPROVEMENT_PROPOSAL.md', 'apps/console/docs/deployment.md', 'apps/console/docs/error-tracking.md', 'content/docs/**', 'docs/ARCHITECTURE.md', 'docs/CONSOLE-STREAMLINING-SUMMARY.md', 'docs/adr/**', 'docs/audits/**', 'packages/**'],
864+
reads: ['README.md', 'apps/console/docs/UI_IMPROVEMENT_PROPOSAL.md', 'apps/console/docs/deployment.md', 'apps/console/docs/error-tracking.md', 'content/docs/**', 'docs/app-shell-extraction-guide.md', 'docs/adr/**', 'docs/audits/**', 'packages/**'],
865865
},
866866
],
867867
[
868868
'scripts/__tests__/check-doc-snippet-types.test.ts',
869869
{
870-
reads: ['README.md', 'apps/console/docs/UI_IMPROVEMENT_PROPOSAL.md', 'apps/console/docs/deployment.md', 'apps/console/docs/error-tracking.md', 'content/docs/**', 'docs/ARCHITECTURE.md', 'docs/CONSOLE-STREAMLINING-SUMMARY.md', 'docs/adr/**', 'docs/audits/**', 'packages/**'],
870+
reads: ['README.md', 'apps/console/docs/UI_IMPROVEMENT_PROPOSAL.md', 'apps/console/docs/deployment.md', 'apps/console/docs/error-tracking.md', 'content/docs/**', 'docs/app-shell-extraction-guide.md', 'docs/adr/**', 'docs/audits/**', 'packages/**'],
871871
walker: 'markdown-tree',
872872
},
873873
],
@@ -1017,7 +1017,7 @@ export const ADJUDICATED = new Map([
10171017
[
10181018
'scripts/__tests__/dollar-dialect-alias-census.test.ts',
10191019
{
1020-
reads: ['./*', '.changeset/**', '.claude/skills/**', 'apps/**', 'content/docs/**', 'docs/ARCHITECTURE.md', 'docs/CONSOLE-STREAMLINING-SUMMARY.md', 'docs/adr/**', 'docs/audits/**', 'examples/**', 'packages/**', 'patches/README.md', 'skills/objectui/**'],
1020+
reads: ['./*', '.changeset/**', '.claude/skills/**', 'apps/**', 'content/docs/**', 'docs/app-shell-extraction-guide.md', 'docs/adr/**', 'docs/audits/**', 'examples/**', 'packages/**', 'patches/README.md', 'skills/objectui/**'],
10211021
},
10221022
],
10231023
[

‎ui/scripts/setup.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ echo -e " ${GREEN}pnpm create-plugin${NC} - Create a new plugin\n"
131131
echo -e "${BLUE}Next steps:${NC}"
132132
echo -e " 1. Read ${GREEN}README.md${NC} for project overview"
133133
echo -e " 2. Read ${GREEN}CONTRIBUTING.md${NC} for contribution guidelines"
134-
echo -e " 3. Read ${GREEN}docs/ARCHITECTURE.md${NC} for architecture insights"
134+
echo -e " 3. Read ${GREEN}content/docs/guide/architecture-overview.md${NC} for architecture insights"
135135
echo -e " 4. Run ${GREEN}pnpm dev${NC} to start coding!\n"
136136

137137
echo -e "${BLUE}Happy coding! 🎉${NC}\n"

0 commit comments

Comments
 (0)