Skip to content

docs(approvals): sync docs + skill to the flow-node model (ADR-0019) - #1409

Merged
xuyushun441-sys merged 1 commit into
mainfrom
docs/adr-0019-approval-node-sync
May 31, 2026
Merged

docs(approvals): sync docs + skill to the flow-node model (ADR-0019)#1409
xuyushun441-sys merged 1 commit into
mainfrom
docs/adr-0019-approval-node-sync

Conversation

@xuyushun441-sys

Copy link
Copy Markdown
Contributor

What

Follow-up to #1408 (ADR-0019 P4/P5), which removed the standalone approval-process engine — approval now exists only as a type: 'approval' flow node. This PR brings the documentation and the automation skill back in sync. No code changes.

Changes

Hand-written

  • skills/objectstack-automation/SKILL.md — removes the deleted ApprovalProcess.create({...}) API; rewrites the approval section to the node model (config schema, approve/reject edges, decision via ApprovalService.decide), adds approval to the Flow node table (18→19, new "Human Decision" group), adds an old→new re-home mapping, refreshes best practices + CRM blueprint.
  • README.md, content/docs/guides/packages.mdx, content/docs/concepts/packages.mdx — fix the plugin one-liner (no more "approval-process engine" / sys_approval_process).

Regenerated auto-docs (content/docs/references/*)

  • approval.mdx now shows ApprovalNodeConfig / ApprovalDecision / ApprovalEscalation / ApproverType (deleted ApprovalAction/ApprovalActionType gone).
  • Also syncs other auto-docs that had drifted but were never regenerated: workflow.mdxstate-machine.mdx, fieldsecret type, ADR-0018 open-registry text in flow.mdx/node-executor.mdx, etc. Deterministic generator output.

Left as-is (historical)

CHANGELOGs, ROADMAP milestone, ADR 0009/0018 — point-in-time records, not retro-edited.

P4/P5 (#1408) removed the standalone approval-process engine; approval now
exists only as a `type: 'approval'` flow node. This brings the docs and the
automation skill back in line with that — no code changes.
- skills/objectstack-automation/SKILL.md: drop the deleted ApprovalProcess
API; rewrite the approval section to the node model (config schema,
approve/reject edges, decision via ApprovalService.decide), add `approval`
to the Flow node table (19 node types), add the old→new re-home mapping,
refresh best practices + CRM blueprint.
- README / guides/packages / concepts/packages: fix the plugin one-liner
(no more "approval-process engine"/sys_approval_process).
- references/*: regenerate auto-docs from current schemas — approval.mdx now
shows ApprovalNodeConfig/ApprovalDecision/etc; also syncs other drifted
auto-docs whose schemas changed but weren't regenerated (workflow.mdx ->
state-machine.mdx, field `secret` type, ADR-0018 open-registry text, …).
Historical records left as-is: CHANGELOGs, ROADMAP milestone, ADR 0009/0018.
@vercel

vercelBot commented May 31, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
specBuildingBuildingPreview, CommentMay 31, 2026 10:33am

Request Review

@github-actionsgithub-actionsBot added the documentation Improvements or additions to documentation label May 31, 2026
@xuyushun441-sys
xuyushun441-sys merged commit 51e35ce into mainMay 31, 2026
7 of 8 checks passed
@xuyushun441-sys
xuyushun441-sys deleted the docs/adr-0019-approval-node-sync branch May 31, 2026 10:33
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationsize/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@xuyushun441-sys@os-zhuang