Skip to content

Commit 4a17645

Browse files
docs(spec): restore the historical table name in the ADR-0006 rename sentence (#13684)
* docs(spec): restore the historical table name in the ADR-0006 rename sentence The sentence documenting the ADR-0006 v4 rename read `sys_environment` was renamed to `sys_environment` — a table renamed to itself. A mechanical project -> environment sweep had rewritten the *historical* name inside the very sentence whose job is to carry it, destroying the one fact the sentence exists to record. The source name is `sys_project`, corroborated at packages/metadata/CHANGELOG.md (`sys_project` -> `sys_environment`, platform-objects object renames) and by ADR-0006 v4 itself. Fixed at the producer: content/docs/references/cloud/environment.mdx is generated from the doc comment in packages/spec/src/cloud/environment.zod.ts by build-docs.ts, so the .mdx is regenerated rather than hand-edited. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pk26oZ12t5N1hwGW1m1MgC * docs(spec): add changeset for the ADR-0006 rename-sentence fix Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pk26oZ12t5N1hwGW1m1MgC --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 193a45e commit 4a17645

3 files changed

Lines changed: 31 additions & 2 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
"@objectstack/spec": patch
3+
---
4+
5+
docs(spec): restore the historical table name in the ADR-0006 rename sentence (#12485)
6+
7+
The Environment protocol's module doc comment — and therefore the generated
8+
page at `content/docs/references/cloud/environment.mdx` — claimed that
9+
`sys_environment` was renamed to `sys_environment`: a table renamed to itself.
10+
The sentence is not merely stale, it is self-refuting, and it destroyed the one
11+
fact it exists to carry, for the reader who consults it precisely because they
12+
are confused about the rename.
13+
14+
The historical name is `sys_project`, corroborated by `packages/metadata`'s
15+
changelog entry for the platform-objects object renames (`sys_project`
16+
`sys_environment`, alongside `sys_project_member` and `sys_project_credential`)
17+
and by ADR-0006 v4 itself.
18+
19+
Cause, which generalises past this one line: a mechanical `project`
20+
`environment` sweep rewrote the *historical* name inside the very sentence
21+
documenting the rename. A sweep that cannot distinguish "the name we use now"
22+
from "the name we used to use" will always corrupt exactly the prose that
23+
explains a rename. **In a sentence that documents a rename, the old name is the
24+
payload — it is not drift, and it must never be "consistency-fixed".**
25+
26+
Fixed at the producer: the `.mdx` under `content/docs/references/` is generated
27+
from the spec source by `build-docs.ts` and pinned by `check:docs`, so the doc
28+
comment in `packages/spec/src/cloud/environment.zod.ts` is the fix site and the
29+
page is regenerated.

content/docs/references/cloud/environment.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This file defines the Control-Plane schemas for the `sys_environment`,
1717
data lives in each environment's own database — those data-plane DBs hold
1818
no system tables.
1919

20-
See ADR-0006 v4: `sys_environment` was renamed to `sys_environment`; the
20+
See ADR-0006 v4: `sys_project` was renamed to `sys_environment`; the
2121
separate dev-workspace `Project` concept introduced in v3 has been
2222
dropped — user code is now modelled as an implicit `sys_package` with
2323
a per-org `manifest_id` (see ADR-0003), so a single package + version

packages/spec/src/cloud/environment.zod.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { lazySchema } from '../shared/lazy-schema';
1717
* data lives in each environment's own database — those data-plane DBs hold
1818
* no system tables.
1919
*
20-
* See ADR-0006 v4: `sys_environment` was renamed to `sys_environment`; the
20+
* See ADR-0006 v4: `sys_project` was renamed to `sys_environment`; the
2121
* separate dev-workspace `Project` concept introduced in v3 has been
2222
* dropped — user code is now modelled as an implicit `sys_package` with
2323
* a per-org `manifest_id` (see ADR-0003), so a single package + version

0 commit comments

Comments
 (0)