Skip to content

docs(getting-started): end-to-end verify all tutorial content; add per-domain skills catalog#3375

Merged
os-zhuang merged 4 commits into
mainfrom
claude/third-party-skills-review-2r4sj1
Jul 21, 2026
Merged

docs(getting-started): end-to-end verify all tutorial content; add per-domain skills catalog#3375
os-zhuang merged 4 commits into
mainfrom
claude/third-party-skills-review-2r4sj1

Conversation

@os-zhuang

@os-zhuang os-zhuang commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

概述

#3374(skills 全面审核)的后续:按同样的“对照真实运行时逐字核实”标准优化整个入门(getting-started)板块,让开发者能顺着 skills 流程完成各类元数据应用的开发。覆盖 7 个内容页(其余 4 页经陈旧特征清单扫描 + 逐项核实确认无需改动)。

验证方法

所有示例代码放进全新 create-objectstack@16.0.0-rc.1 脚手架项目实际运行;所有 CLI 命令对照 packages/cli/src/commands/ 源码逐条核实并实跑采样;所有速查表行 grep 核实到 Zod 源文件。

各页修改

build-with-claude-code + your-first-project(第一批)

  • 教程三个示例文件 os validate 逐字通过;curl 流程原样可运行;MCP 工具表与注册面一致
  • 修正 pnpm 必装前提、过时 v6.x 横幅;补上 agent 把新文件接线进 objectstack.config.ts 的说明
  • 新增 “Beyond the first app — one skill per metadata domain”:9 个 skill × 领域 × 照抄即用示例提示词
  • your-first-project 新增 “Hand the project to your agent” 衔接章节;两页均补 os lint --score

cli.mdx

  • 每条命令/flag 源码核实;validate/info/compile/build/lint --score/--help 实跑并对齐输出样例
  • 修正 os start 认证描述(原文称无 secret 则跳过认证;实际自动生成并持久化 secret,开箱即用);补全 artifact 解析链、--home--fresh/--seed-admin;删除 monorepo 内部的 ../objectui Vite 说明

common-patterns.mdx

  • 十大模式全部实测:按原文投放(validate 通过——证明这些坑是 validate 抓不到的),修复后再过一遍
  • 两个流程模式缺 start 节点 trigger 绑定,validate 通过但永不触发;审批节点空 config 是 no-op;reference: 'user'sys_user;notify 收件人是用户 id 而非 .email 路径;公式字段裸标识符 → record. 前缀;cursor 分页 → keyset

validating-metadata.mdx

  • 补真实形态的成功输出样例;修正 validate 与 compile/build 的检查项差异描述;删除 monorepo 内部指令

quick-reference.mdx(约 45 处)

  • 删除不存在的 compliance.zod.ts/masking.zod.ts 行;Dataset 移到 UI 表;AI 表 3→11 行补齐 RAG/成本跟踪相关 schema;修正约 35 个过时的 Key Schemas 名称(每个替换名都 grep 核实)

quick-start.mdx

  • 逐项核实后无需改动(示例是已验证代码的子集,结构描述与真实模板一致)

验证

  • pnpm --filter docs build 本地通过(两轮)
  • 全部实验在独立项目副本进行,用后清理;未动共享资源

🤖 Generated with Claude Code

https://claude.ai/code/session_012Kj2MJEPXoUXC4LiC3XYJc

…n skills catalog

Every load-bearing claim on build-with-claude-code and your-first-project
was re-verified in a freshly scaffolded 16.0.0-rc.1 project: the three
tutorial example files pass os validate verbatim, the bare-reference
error text matches the real gate output word-for-word, the curl flow
(sign-in → create → select/sort/top query) runs as written, and the MCP
endpoint/tool table matches the registered tool surface.

build-with-claude-code:
- prerequisites no longer claim pnpm is required (npm suffices; matches
  your-first-project); stale 'Create ObjectStack v6.x' banner replaced
  with the current scaffolder output incl. Next steps
- document that the agent wires new files into objectstack.config.ts
  (actions:/views: arrays + objects barrel) — previously unmentioned,
  and the first thing to check when authored metadata doesn't show up
- new section 'Beyond the first app — one skill per metadata domain':
  maps all nine skills to the metadata domain they drive with a
  copy-paste example prompt each, plus the two habits that keep the
  loop reliable (validate gates every domain; re-run skills add after
  spec upgrades)
- surface the os lint --score quality rubric in the iterate step

your-first-project:
- surface os lint --score after the validate gate
- new section '7. Hand the project to your agent' bridging the manual
  path to the skills-driven loop with a cross-domain example prompt and
  a link to the per-domain catalog

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Kj2MJEPXoUXC4LiC3XYJc
@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 21, 2026 1:33am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s and removed documentation Improvements or additions to documentation labels Jul 21, 2026
claude added 3 commits July 21, 2026 01:22
Every command/subcommand/flag on the page is now verified against
packages/cli/src/commands/; validate, info, compile, build, lint --score
and --help were executed in a real 16.0.0-rc.1 consumer app and the
printed samples updated to match actual output.

- os start: the page claimed auth is silently skipped without a secret —
  reality is --auth-secret > OS_AUTH_SECRET > an auto-generated secret
  persisted at <home>/auth-secret, so auth works out of the box
  (start.ts readOrCreateAuthSecret); documented the full artifact
  resolution chain incl. config auto-compile and the empty-kernel
  fallback, and the missing --home flag.
- Replaced the monorepo-internal '../objectui Vite server' Console note
  with the consumer reality (prebuilt bundle served at /_console/).
- os compile / os info samples regenerated from real runs; os dev gains
  --fresh/--seed-admin rows + the persistent dev-DB note and the seeded
  admin / MCP endpoint mention; added the missing os build alias and an
  os lint section (--score/--fix/--json); serve auth tier note gains
  the dev-fallback-secret parenthetical.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Kj2MJEPXoUXC4LiC3XYJc
All ten patterns were dropped verbatim into a scaffolded 16.0.0-rc.1 app
and run through npm run validate — twice: as-published (passes, proving
the gate does NOT catch these) and as-fixed. The fixes target
runtime-fatal issues invisible to validate:

- Both flow patterns lacked the start-node trigger binding
  (config.objectName + triggerType: 'record-after-update' …) — they
  validated but never fired; approval-flow nodes (auto_approve /
  request_approval / update_record) had no config at all, making them
  no-ops. Bindings, node configs, status: 'active', and a CEL start
  condition added.
- reference: 'user' → 'sys_user' (no 'user' object exists; lookups
  silently never resolve).
- notify recipient '{record.assigned_to.email}' → '{record.assigned_to}'
  (recipients are user ids; path-walking a string yields empty
  recipients and a node error).
- Formula field: bare 'quantity * unit_price' →
  'record.quantity * record.unit_price' + returnType (bare identifiers
  resolve to null in the CEL scope).
- Cursor-pagination section replaced with keyset pagination (cursor is
  schema-reserved, zero engine/driver execution — same finding as
  PR #3374).
- Frontmatter description no longer promises realtime; import callout
  gains definePermissionSet.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Kj2MJEPXoUXC4LiC3XYJc
…eference

quick-start (Anatomy) verified claim-by-claim against the Zod sources
and the blank template — no changes needed.

validating-metadata:
- added a real-shaped clean-run output sample (step lines match
  validate.ts printStep calls verbatim);
- corrected gate-parity wording: compile/build shares the core
  validators, while os validate additionally runs list-view modes
  (ADR-0053), view-container shape, and JSX/React page-source checks
  (ADR-0080/0081);
- removed the monorepo-internal pnpm --filter instruction.

quick-reference (~45 corrections, each grep-verified in
packages/spec/src):
- removed rows for nonexistent compliance.zod.ts / masking.zod.ts and a
  duplicated Service Registry row; moved Dataset from Data to UI;
- expanded the AI table 3→11 rows (Skill, Tool, MCP, Embedding,
  Knowledge Source/Document, Usage, Solution Blueprint — the section
  advertised RAG/cost tracking with zero matching rows);
- added Environment (cloud) and Expression (shared) rows;
- fixed ~35 stale Key Schemas names to real exports (QueryOptions→
  QueryAST, PluginHook→PluginLifecycle, Auth→LoginRequest/Session,
  Channel→RealtimeEvent, Package→MarketplaceListing/PackageSubmission,
  all seven kernel plugin-* rows, …) and updated table counts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Kj2MJEPXoUXC4LiC3XYJc
@github-actions github-actions Bot added size/m documentation Improvements or additions to documentation size/s and removed size/s labels Jul 21, 2026
@os-zhuang os-zhuang changed the title docs(getting-started): verify tutorial code end-to-end; add per-domain skills catalog docs(getting-started): end-to-end verify all tutorial content; add per-domain skills catalog Jul 21, 2026
@os-zhuang
os-zhuang marked this pull request as ready for review July 21, 2026 02:13
@os-zhuang
os-zhuang merged commit ed61cd5 into main Jul 21, 2026
15 checks passed
@os-zhuang
os-zhuang deleted the claude/third-party-skills-review-2r4sj1 branch July 21, 2026 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants