From 16722a7c5331f9f927d6bc4e3c601f4b39d0c000 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 18 Aug 2026 21:54:18 +0000 Subject: [PATCH] docs(service-automation): See Also names the two docs pages it lands on (#9668) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `Flow Builder Guide` resolves to the Automation section index (title: Automation) and `Trigger Reference` to the automation schema reference index (title: Automation Protocol), which lists every automation schema rather than triggers. Both destinations are the right section-level target, so only the labels changed — each is now the destination page's own `title` frontmatter, glossed from that page's own `description`. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01XqDQYVU5smx29ts9pAErja --- .changeset/automation-readme-link-labels.md | 27 +++++++++++++++++++ .../services/service-automation/README.md | 6 +++-- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 .changeset/automation-readme-link-labels.md diff --git a/.changeset/automation-readme-link-labels.md b/.changeset/automation-readme-link-labels.md new file mode 100644 index 0000000000..18435d556e --- /dev/null +++ b/.changeset/automation-readme-link-labels.md @@ -0,0 +1,27 @@ +--- +"@objectstack/service-automation": patch +--- + +`service-automation`'s README labels its two docs links with the pages they land on (#9668) + +Two entries in the README's See Also list named artifacts that are not what the link +resolves to. `Flow Builder Guide` lands on the Automation **section index** +(`content/docs/automation/index.mdx`, `title: Automation`); `Trigger Reference` lands on +the automation **schema** reference index (`content/docs/references/automation/index.mdx`, +`title: Automation Protocol`), which lists every automation schema — approval, flow, +state-machine, webhook and eleven more — not triggers. Both destinations resolve and both +are the right section-level target for a package README, so the mismatch is on the label +axis, not the destination axis, and only the labels changed. + +Each new label is the destination page's own `title` frontmatter, with a gloss compressed +from that page's own `description`, so the label is checkable against the page rather than +invented. **No URL changed**, and in particular the plausible-looking +`references/studio/flow-builder` was not adopted: it is a **Studio** reference, not the +automation service's. + +The third docs link in this README — `Flows`, at the end of the flow-node section — was +verified and left alone. It points at a specific page (`content/docs/automation/flows.mdx`, +`title: Flow Metadata`), and that page does carry the per-node `config` reference, loop and +parallel containers, subflows, waits and error handling that the sentence promises. + +Documentation only: no API, behaviour or type surface changes. diff --git a/packages/services/service-automation/README.md b/packages/services/service-automation/README.md index 299ba5ffd8..06fe157f01 100644 --- a/packages/services/service-automation/README.md +++ b/packages/services/service-automation/README.md @@ -456,5 +456,7 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md). ## See Also - [@objectstack/spec/automation](../../spec/src/automation/) -- [Flow Builder Guide](https://docs.objectstack.ai/docs/automation) -- [Trigger Reference](https://docs.objectstack.ai/docs/references/automation) +- [Automation](https://docs.objectstack.ai/docs/automation) — the automation docs section: hooks, flows, + workflows, approvals, webhooks, connectors +- [Automation Protocol](https://docs.objectstack.ai/docs/references/automation) — the complete schema + reference for the automation protocol