Repository navigation
Commit 25a697e
docs: one North Star — docs/NORTH-STAR.md; the architecture page moves to concepts/architecture-overview (#26970)
Fixes #26073
Clause-②: no
Metadata-protocol: none
## 维护者速读
- 改了什么:「北极星」从此只指 `docs/NORTH-STAR.md`。原架构页 `concepts/north-star` 改名为
`concepts/architecture-overview`(旧网址 308 永久跳转),删掉会过期的 Built、Drift To
Keep Shrinking 两节。AGENTS.md(第 7 行与 Prime Directive
8)、ROADMAP、CONTRIBUTING、README 四处入口统一指向它。`docs/NORTH-STAR.md`
末尾加了一节英文摘要,中文原文一字未动。
- 为什么改:执行裁决 A′(6417934431,「同意」)。两份同名文件让读者有一半概率打开错的那份,而真正高于 AGENTS.md
的那份,英文贡献者读不了。
- 风险与回滚:只改文档,不碰任何发布包。站外指向旧网址的链接由 redirects 表兜底。回滚 = revert 本 PR。
- 先看:① `docs/NORTH-STAR.md` 末尾的英文摘要:是否忠实于中文原文、有没有新增规则;② `AGENTS.md` 第 7
行与 Prime Directive 8 的新措辞;③
`content/docs/concepts/architecture-overview.mdx`。
- 两分钟验证:`git diff origin/main...HEAD -- docs/NORTH-STAR.md | grep -c
'^-[^-]'`,应输出 `0`,即中文原文没有删改任何一行。
- 需要你做的:本 PR 是 Tier H(改了 `AGENTS.md` 和 `docs/NORTH-STAR.md`)。请审阅英文摘要与
PD8 的措辞,然后用 GOVERNED_APPROVERS 里的账号批准本 PR。
## What changes
Ruling A′ (comment 6417934431), all three items:
1. **The architecture page gets an honest name.**
`content/docs/concepts/north-star.mdx` is renamed to
`architecture-overview.mdx`, with a new title and nav title. It keeps
Principles, Runtime Shape, Environment Artifact, Request Resolution and
Non-Goals. The **Built** and **Drift To Keep Shrinking** sections are
removed. One sentence under the opening diagram now points readers to
the North Star for goals and priority. `content/docs/concepts/meta.json`
lists the new slug. `apps/docs/redirects.mjs` gains one entry,
`/docs/concepts/north-star` → `/docs/concepts/architecture-overview`, so
the old URL answers a permanent redirect.
2. **One North Star.** `AGENTS.md` line 7 and Prime Directive 8 now
point at `docs/NORTH-STAR.md`. Prime Directive 8 is re-pointed at that
file's 路上的功能点 ladder, graded by its 优先级, and no longer refers to "§7
Built / Drift / Missing". `ROADMAP.md` line 4 and `CONTRIBUTING.md` name
`docs/NORTH-STAR.md` as the one North Star. The README Community line
linked the site page and now links the file. The two hand-written site
pages that linked the old slug now link the new one:
`content/docs/concepts/metadata-lifecycle.mdx` (only the link line
changed) and `content/docs/data-modeling/formulas.mdx` (two links).
3. **English summary.** `docs/NORTH-STAR.md` gains a `## English
summary` section under the Chinese text. It covers the four opening
questions, the one measure (the road), and how to read the ladder,
including how grading reads it. It says that the Chinese text governs.
It carries no numbers, following that page's own 账本 rule, and it adds no
rule. The Chinese original is untouched: 53 lines are added and none are
removed.
`scripts/docs-audit/handwritten-docs.json` was regenerated by its
generator (`node scripts/docs-audit/check-audit-scope.mjs --write`; +1
added, -1 removed).
No changeset (`skip-changeset`): every changed path is either private
(`apps/docs`, the root package) or unpublished (docs, `content/docs`,
`scripts/`).
## Tests
This diff is docs-only, so it has no unit tests. Verification is the
derived gate list, run on the final head `43cb2c7e83`. See Verification.
## Acceptance notes
- **Re-derived "five site pages".** Five pages on `origin/main` linked
or named the old page. Two are hand-written and were moved:
`concepts/metadata-lifecycle.mdx` L174 and `data-modeling/formulas.mdx`
L29 and L695. Two are GENERATED and were left alone:
`references/shared/expression.mdx` L55 and
`references/system/environment-artifact.mdx` L45. One is RELEASE-OWNED
and was left alone: `releases/v17/17-6.mdx` L1483, whose URL the new
redirect covers.
- **Generator sources of the two generated mentions, not edited here (as
dispatched).** These are plain-text paths, not links, so the redirect
does not rescue them:
- `packages/spec/src/shared/expression.zod.ts:59`, which renders as
`references/shared/expression.mdx`, cites `north-star.mdx §8 "No private
expression DSL"`.
- `packages/spec/src/system/environment-artifact.zod.ts:46`, which
renders as `references/system/environment-artifact.mdx`, cites `§6.3`.
The same kind of mention is in
`packages/spec/src/data/hook-body.zod.ts:256` ("Metadata-only runtime"),
`packages/formula/src/index.ts:8` and `packages/formula/README.md:9`
(the formula README is published). All five cite sections that were
already missing from the page on base `e4ba846f`, because the page has
no numbered sections and no such headings. They were stale before this
PR, and the rename makes the file path dangling as well. Fixing them
means choosing a new citation and spending a changeset plus `gen:docs`,
which is outside this card. carrier: none.
- **Release-owned history keeps the old path.** Root `CHANGELOG.md`
L1033 links `content/docs/concepts/north-star.mdx`, and it also mentions
"§7 Missing in the North Star" at L1125. The rule for release-owned text
is not to edit it.
- **The card's confidence gap, measured.** `git grep
concepts/north-star` across `README.md`, `ui/`, `apps/docs` and the
redirects ledger found one hit: README L270, a site link, now re-pointed
to `./docs/NORTH-STAR.md`. `ui/` has one North Star reference,
`ui/ROADMAP.md:14`, and it already points at `docs/NORTH-STAR.md`.
`apps/docs` had no entry for the slug before this PR. Inbound links from
outside the repository cannot be measured from here, and the permanent
redirect covers them.
- **`AGENTS.md` line 7 lost its `(先做什么: goals, priority)`
parenthetical.** `pnpm check:pm-skill-ratchet` holds `AGENTS.md` to 120
bytes per line, and the file sits at its 1112-line ceiling with zero
headroom. A version that kept the parenthetical (152 B) went red, and
wrapping it would add a line the ceiling does not allow. The line now
reads "`docs/NORTH-STAR.md`, the North Star, outranks it;
`content/docs/concepts/architecture-overview.mdx` = architecture." (116
B). What the North Star governs is still stated in Prime Directive 8 and
in the summary.
- `ROADMAP.md`'s "Last updated" date was left unchanged, because only
the source-of-truth pointer moved.
## Verification
Final head `43cb2c7e83` (after merging `origin/main` twice; no incoming
commit touches this diff's files). `node scripts/pm/dispatch-gates.mjs
--commands --repo objectstack-ai/objectstack` derived 69 commands. All
69 were run with the exit code captured before any pipe, and every one
exited 0. `--ran` reconciled the list: `69 derived, 69 run, 0
NOT-MEASURED, 0 UNRUN` ("a DERIVED zero — all 69 recorded an exit code
and none of them is 3").
<details>
<summary>Gate readings named by the dispatch</summary>
- `pnpm check:docs-redirects` exit 0: `check-docs-redirects: OK
(apps/docs/redirects.mjs: 99 entries -- 96 page destination(s) resolved
against content/docs, 3 wildcard destination(s) resolved to a directory,
0 outside the /docs route space, 105 chain probe(s) matched against
every source).`
- `pnpm check:doc-authoring` exit 0: `doc authoring guard: 19557
customer-facing string(s) across 1495 spec sources clean`
- `pnpm check:pm-governed-prose` exit 0: `check-governed-prose: 2
instruction surface(s) name all 13 registered governed surfaces that
govern objectstack`
- `pnpm check:doc-anchors` exit 0: `628 internal #fragment link(s)
across 432 source file(s) all resolve to a real heading`
- `pnpm check:docs-audit-scope` exit 0 (with the handwritten-docs
manifest regenerated).
- `pnpm check:pm-skill-ratchet` exit 0 on the final head. The first run
(exit 1) flagged `AGENTS.md L7 (152B)`, which was fixed in `2ee65f9627`.
- Link check (lychee, `check-links.yml`): NOT MEASURED locally, reason:
lychee is not installed in this container. The advisory CI lane runs
over `content/**` and the root `README.md`.
</details>
<details>
<summary>Build-dependent gates</summary>
- `pnpm check:docs-transcript-drift` first answered `PREREQUISITE NOT
MET` (exit 3, `@objectstack/lint` unbuilt). After `pnpm
--workspace-concurrency=2 --filter '@objectstack/lint...' build` under
the verify lock (`VERDICT command-exit 0`), it exited 0: `4 declared
transcript value(s) across 426 page(s) under content/docs/ equal what
the registry derives today`.
- `pnpm --filter @objectstack/spec run check:skill-examples` first
answered exit 3 (`packages/client-react/dist` unbuilt). After `--filter
'@objectstack/client-react...' build` under the lock (`VERDICT
command-exit 0`), it exited 0: `267 prose examples type-check across 3
surface(s)`.
- `pnpm --filter @objectstack/spec run check:docs` exit 0: `232
generated files in sync with packages/spec`.
</details>
---
_Generated by [Claude
Code](https://claude.ai/code/session_01QSeKYmTYfaPbLQD4BJfomW)_
---------
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: objectstack-fleet[bot] <332303061+objectstack-fleet[bot]@users.noreply.github.com>1 parent 4f93696 commit 25a697e
11 files changed
Lines changed: 75 additions & 46 deletions
File tree
- apps/docs
- content/docs
- concepts
- data-modeling
- docs
- scripts/docs-audit
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
194 | 194 | | |
195 | 195 | | |
196 | 196 | | |
197 | | - | |
198 | | - | |
| 197 | + | |
| 198 | + | |
199 | 199 | | |
200 | 200 | | |
201 | 201 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | | - | |
| 115 | + | |
| 116 | + | |
116 | 117 | | |
117 | 118 | | |
118 | 119 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
292 | 292 | | |
293 | 293 | | |
294 | 294 | | |
295 | | - | |
| 295 | + | |
296 | 296 | | |
297 | 297 | | |
298 | 298 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
23 | 26 | | |
24 | 27 | | |
25 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | | - | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
19 | 23 | | |
20 | 24 | | |
21 | 25 | | |
| |||
101 | 105 | | |
102 | 106 | | |
103 | 107 | | |
104 | | - | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
119 | | - | |
120 | | - | |
121 | | - | |
122 | | - | |
123 | | - | |
124 | | - | |
125 | | - | |
126 | | - | |
127 | | - | |
128 | | - | |
129 | | - | |
130 | | - | |
131 | | - | |
132 | | - | |
133 | | - | |
134 | | - | |
135 | | - | |
136 | 108 | | |
137 | 109 | | |
138 | 110 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
176 | 176 | | |
177 | 177 | | |
178 | 178 | | |
179 | | - | |
| 179 | + | |
180 | 180 | | |
181 | 181 | | |
182 | 182 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | | - | |
| 29 | + | |
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| |||
692 | 692 | | |
693 | 693 | | |
694 | 694 | | |
695 | | - | |
| 695 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
123 | 123 | | |
124 | 124 | | |
125 | 125 | | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
0 commit comments