Commit c77ac65
docs: sync remaining 82 hand-written docs with actual implementation (audit pass 2) (#1904)
Finishes the implementation-accuracy audit started in #1866 (which covered 46
docs in getting-started/concepts/guides). This pass covers the remaining 82
hand-written docs — guides (incl. cheatsheets/contracts/metadata/runtime-services),
protocol (objectos/objectql/objectui), releases, and the docs index.
A multi-agent audit read each doc, located the real implementation in packages/,
and adversarially verified every finding against the code (a second verifier
re-checked each applied fix and repaired over-corrections). This applies 486
verified fixes across 73 docs, plus 28 verifier repairs. Auto-generated
references/ docs (DO-NOT-EDIT, produced from packages/spec) were excluded.
Recurring classes of fix:
- broken-example / inaccurate-api: code samples and method names that don't
exist or changed — fabricated transaction methods (tx.insert/tx.update),
non-existent helpers (definePlugin), wrong package names
(@objectstack/services/service-cache -> @objectstack/service-cache),
ViewFieldSchema -> FormFieldSchema, wrong @objectstack/spec subpath imports.
- fabricated-feature: field-type props that aren't in the schema
(sanitize/allowed_tags/protocols/region/rows), a phantom `Workflow` metadata
type with *.workflow.ts conventions, fabricated CLI scaffold output.
- naming/enum drift: max_length -> maxLength; relationship/complex type lists
corrected to real enum values; OWDModel value spellings (public_read/...).
- security model: FLS non-editable write rejects with PermissionDeniedError
(403) rather than silent strip; PermissionSet over Salesforce-style shapes.
- outdated paths/env: OS_EMAIL__PROVIDER double-underscore, /v1 REST prefixes,
config-resolution precedence and envKey coercion examples.
Navigation-safe: no files moved, frontmatter preserved on every doc.
Verified: `next build` compiles all 1113 pages clean (exit 0).
Residual items the audit could not confirm against code, plus the observation
that committed references/ have drifted from spec, are recorded in
docs/audits/2026-06-handwritten-docs-accuracy-followups.md for a follow-up pass.
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent ce1aba9 commit c77ac65
74 files changed
Lines changed: 3962 additions & 5517 deletions
File tree
- content/docs
- guides
- cheatsheets
- contracts
- metadata
- runtime-services
- protocol
- objectos
- objectql
- objectui
- docs/audits
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
665 | 665 | | |
666 | 666 | | |
667 | 667 | | |
668 | | - | |
| 668 | + | |
669 | 669 | | |
670 | 670 | | |
671 | 671 | | |
| |||
1068 | 1068 | | |
1069 | 1069 | | |
1070 | 1070 | | |
1071 | | - | |
1072 | 1071 | | |
1073 | 1072 | | |
1074 | 1073 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
167 | 167 | | |
168 | 168 | | |
169 | 169 | | |
170 | | - | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
177 | | - | |
178 | | - | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
179 | 185 | | |
180 | 186 | | |
181 | 187 | | |
| |||
Lines changed: 18 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
| 114 | + | |
115 | 115 | | |
116 | | - | |
| 116 | + | |
117 | 117 | | |
118 | 118 | | |
119 | | - | |
120 | | - | |
| 119 | + | |
| 120 | + | |
121 | 121 | | |
122 | | - | |
123 | | - | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
124 | 130 | | |
125 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
126 | 136 | | |
127 | 137 | | |
128 | 138 | | |
129 | 139 | | |
130 | 140 | | |
131 | 141 | | |
132 | | - | |
133 | | - | |
| 142 | + | |
134 | 143 | | |
135 | 144 | | |
136 | 145 | | |
| |||
160 | 169 | | |
161 | 170 | | |
162 | 171 | | |
163 | | - | |
| 172 | + | |
164 | 173 | | |
165 | 174 | | |
166 | 175 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| |||
210 | 210 | | |
211 | 211 | | |
212 | 212 | | |
213 | | - | |
| 213 | + | |
214 | 214 | | |
215 | 215 | | |
216 | 216 | | |
| |||
372 | 372 | | |
373 | 373 | | |
374 | 374 | | |
375 | | - | |
376 | | - | |
377 | | - | |
378 | | - | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
379 | 380 | | |
380 | 381 | | |
381 | 382 | | |
| |||
Lines changed: 28 additions & 33 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
41 | | - | |
42 | | - | |
| 41 | + | |
43 | 42 | | |
44 | 43 | | |
45 | 44 | | |
| 45 | + | |
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
65 | 64 | | |
66 | 65 | | |
67 | 66 | | |
68 | 67 | | |
69 | | - | |
| 68 | + | |
70 | 69 | | |
71 | 70 | | |
72 | 71 | | |
73 | | - | |
| 72 | + | |
74 | 73 | | |
75 | 74 | | |
76 | 75 | | |
77 | 76 | | |
78 | 77 | | |
79 | 78 | | |
80 | 79 | | |
81 | | - | |
| 80 | + | |
82 | 81 | | |
83 | 82 | | |
84 | | - | |
85 | | - | |
| 83 | + | |
86 | 84 | | |
87 | 85 | | |
88 | 86 | | |
| |||
94 | 92 | | |
95 | 93 | | |
96 | 94 | | |
97 | | - | |
98 | 95 | | |
99 | 96 | | |
100 | 97 | | |
| 98 | + | |
101 | 99 | | |
102 | 100 | | |
103 | 101 | | |
| |||
110 | 108 | | |
111 | 109 | | |
112 | 110 | | |
113 | | - | |
114 | 111 | | |
115 | 112 | | |
116 | 113 | | |
| |||
123 | 120 | | |
124 | 121 | | |
125 | 122 | | |
126 | | - | |
127 | 123 | | |
128 | 124 | | |
129 | 125 | | |
| |||
141 | 137 | | |
142 | 138 | | |
143 | 139 | | |
144 | | - | |
| 140 | + | |
| 141 | + | |
145 | 142 | | |
146 | 143 | | |
147 | 144 | | |
148 | 145 | | |
149 | 146 | | |
150 | | - | |
151 | | - | |
| 147 | + | |
152 | 148 | | |
153 | 149 | | |
154 | 150 | | |
| 151 | + | |
155 | 152 | | |
156 | 153 | | |
157 | 154 | | |
| |||
179 | 176 | | |
180 | 177 | | |
181 | 178 | | |
182 | | - | |
183 | 179 | | |
184 | 180 | | |
185 | 181 | | |
| |||
189 | 185 | | |
190 | 186 | | |
191 | 187 | | |
192 | | - | |
193 | | - | |
194 | | - | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
195 | 191 | | |
196 | 192 | | |
197 | 193 | | |
198 | 194 | | |
199 | 195 | | |
200 | 196 | | |
201 | | - | |
| 197 | + | |
202 | 198 | | |
203 | 199 | | |
204 | 200 | | |
| |||
209 | 205 | | |
210 | 206 | | |
211 | 207 | | |
212 | | - | |
| 208 | + | |
213 | 209 | | |
214 | 210 | | |
215 | 211 | | |
216 | 212 | | |
217 | 213 | | |
218 | | - | |
219 | | - | |
| 214 | + | |
220 | 215 | | |
221 | 216 | | |
222 | 217 | | |
| |||
235 | 230 | | |
236 | 231 | | |
237 | 232 | | |
238 | | - | |
| 233 | + | |
239 | 234 | | |
240 | 235 | | |
241 | 236 | | |
242 | | - | |
| 237 | + | |
243 | 238 | | |
244 | 239 | | |
245 | 240 | | |
246 | 241 | | |
247 | 242 | | |
248 | 243 | | |
249 | 244 | | |
250 | | - | |
251 | | - | |
| 245 | + | |
| 246 | + | |
252 | 247 | | |
253 | | - | |
254 | | - | |
255 | | - | |
256 | | - | |
257 | | - | |
258 | | - | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
259 | 254 | | |
260 | 255 | | |
261 | | - | |
| 256 | + | |
262 | 257 | | |
0 commit comments