Commit 7d94d2f
docs: sync 46 hand-written docs with actual implementation (reader-facing audit) (#1866)
* docs: sync 46 hand-written docs with actual implementation (reader-facing audit)
A multi-agent audit read each hand-written doc, located the real
implementation in packages/, and adversarially verified every finding
against the code. This applies 299 verified fixes across 46 docs in
getting-started, concepts, and guides. Auto-generated references/ docs
(DO-NOT-EDIT, produced from packages/spec) were intentionally excluded.
Recurring classes of fix:
- broken-example / inaccurate: code samples calling APIs that don't exist
or changed — e.g. `os studio` (no such command → `os dev --ui`),
`client.meta.getObject()` → `meta.getItem('object', …)`,
`client.ai.chat()` removed, `client.workflow.approve/reject` moved to
the request-id `client.approvals.*` API (ADR-0019), `defineProfile` /
`defineAction` / `defineHook` helpers that don't exist.
- security model: replaced Salesforce-styled fabricated API (Profile type,
objectPermissions/fieldPermissions) with the real PermissionSet schema
(objects/fields, allowCreate/allowRead/…, isProfile); fixed sharing
rules, OWD enums, role hierarchy.
- outdated: Salesforce UPPERCASE formulas → CEL; portal path /_studio →
/_console; REST path /api/v1/{object} → /api/v1/data/{object};
AUTH_SECRET → canonical OS_AUTH_SECRET; PORT → OS_PORT.
- fabricated features removed/qualified: RAG/NLQ/Predictive sections in
ai-capabilities; VITE_RUNTIME_MODE & ?mode= switch in deployment-vercel
(real flag is VITE_USE_MOCK_SERVER); GraphQL presented as contract-only.
- broken links/paths repointed (objectstack-ai/spec → …/framework).
Navigation-safe: no files moved, frontmatter preserved on every doc.
Verified: `next build` compiles all 1107 pages clean; spot-checked
rendering in the browser.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* docs(skills): fix formula SKILL.md trigger phrasing at the source
The formula skill description used "Use whenever", which build-skill-docs.ts's
`Use when` split regex doesn't match, so the generated catalog duplicated the
"Do not use" clause. Fix the source phrasing to "Use when" and regenerate, so
content/docs/guides/skills.mdx stays in sync (check:skill-docs passes) instead
of hand-patching the generated block.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent d8efb0a commit 7d94d2f
48 files changed
Lines changed: 2782 additions & 3008 deletions
File tree
- content/docs
- concepts
- core
- getting-started
- guides
- skills
- objectstack-formula
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 | |
|---|---|---|---|
| |||
143 | 143 | | |
144 | 144 | | |
145 | 145 | | |
146 | | - | |
147 | | - | |
148 | | - | |
149 | | - | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
163 | 161 | | |
164 | | - | |
165 | | - | |
166 | | - | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
175 | 167 | | |
176 | 168 | | |
177 | 169 | | |
178 | 170 | | |
179 | | - | |
180 | | - | |
181 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
182 | 174 | | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
188 | 188 | | |
189 | | - | |
190 | | - | |
191 | | - | |
192 | | - | |
193 | | - | |
194 | | - | |
195 | | - | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
201 | 194 | | |
202 | 195 | | |
203 | 196 | | |
204 | 197 | | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
205 | 205 | | |
206 | 206 | | |
207 | 207 | | |
| |||
220 | 220 | | |
221 | 221 | | |
222 | 222 | | |
223 | | - | |
224 | | - | |
| 223 | + | |
| 224 | + | |
225 | 225 | | |
226 | | - | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
227 | 229 | | |
228 | | - | |
229 | | - | |
230 | | - | |
231 | | - | |
232 | | - | |
233 | | - | |
234 | | - | |
235 | | - | |
236 | | - | |
237 | | - | |
238 | | - | |
239 | | - | |
240 | | - | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
241 | 236 | | |
242 | 237 | | |
243 | 238 | | |
244 | 239 | | |
245 | 240 | | |
246 | 241 | | |
247 | | - | |
248 | | - | |
| 242 | + | |
| 243 | + | |
249 | 244 | | |
250 | | - | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
251 | 248 | | |
252 | | - | |
253 | | - | |
254 | | - | |
255 | | - | |
256 | | - | |
257 | | - | |
258 | | - | |
259 | | - | |
260 | | - | |
261 | | - | |
262 | | - | |
263 | | - | |
264 | | - | |
265 | | - | |
266 | | - | |
267 | | - | |
268 | | - | |
269 | | - | |
270 | | - | |
271 | | - | |
272 | | - | |
273 | | - | |
274 | | - | |
275 | | - | |
276 | | - | |
277 | | - | |
278 | | - | |
279 | | - | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
280 | 264 | | |
281 | 265 | | |
282 | 266 | | |
| |||
290 | 274 | | |
291 | 275 | | |
292 | 276 | | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
293 | 284 | | |
294 | 285 | | |
295 | 286 | | |
| |||
431 | 422 | | |
432 | 423 | | |
433 | 424 | | |
434 | | - | |
435 | | - | |
436 | | - | |
437 | | - | |
438 | | - | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
439 | 436 | | |
440 | | - | |
441 | | - | |
442 | | - | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
443 | 441 | | |
444 | 442 | | |
445 | 443 | | |
446 | 444 | | |
447 | 445 | | |
448 | 446 | | |
449 | 447 | | |
450 | | - | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
451 | 454 | | |
452 | | - | |
453 | | - | |
454 | | - | |
455 | | - | |
456 | | - | |
457 | | - | |
458 | | - | |
459 | | - | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
460 | 464 | | |
461 | 465 | | |
462 | 466 | | |
| |||
546 | 550 | | |
547 | 551 | | |
548 | 552 | | |
549 | | - | |
| 553 | + | |
550 | 554 | | |
551 | 555 | | |
552 | 556 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
100 | 105 | | |
101 | 106 | | |
102 | 107 | | |
| |||
108 | 113 | | |
109 | 114 | | |
110 | 115 | | |
111 | | - | |
112 | | - | |
| 116 | + | |
| 117 | + | |
113 | 118 | | |
114 | 119 | | |
115 | 120 | | |
| |||
0 commit comments