Skip to content

Commit bcf2755

Browse files
os-steveclaude
andauthored
docs(service-automation): See Also names the two docs pages it lands on (#9668) (#9749)
`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`. Claude-Session: https://claude.ai/code/session_01XqDQYVU5smx29ts9pAErja Co-authored-by: Claude <noreply@anthropic.com>
1 parent e2899f6 commit bcf2755

2 files changed

Lines changed: 31 additions & 2 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
"@objectstack/service-automation": patch
3+
---
4+
5+
`service-automation`'s README labels its two docs links with the pages they land on (#9668)
6+
7+
Two entries in the README's See Also list named artifacts that are not what the link
8+
resolves to. `Flow Builder Guide` lands on the Automation **section index**
9+
(`content/docs/automation/index.mdx`, `title: Automation`); `Trigger Reference` lands on
10+
the automation **schema** reference index (`content/docs/references/automation/index.mdx`,
11+
`title: Automation Protocol`), which lists every automation schema — approval, flow,
12+
state-machine, webhook and eleven more — not triggers. Both destinations resolve and both
13+
are the right section-level target for a package README, so the mismatch is on the label
14+
axis, not the destination axis, and only the labels changed.
15+
16+
Each new label is the destination page's own `title` frontmatter, with a gloss compressed
17+
from that page's own `description`, so the label is checkable against the page rather than
18+
invented. **No URL changed**, and in particular the plausible-looking
19+
`references/studio/flow-builder` was not adopted: it is a **Studio** reference, not the
20+
automation service's.
21+
22+
The third docs link in this README — `Flows`, at the end of the flow-node section — was
23+
verified and left alone. It points at a specific page (`content/docs/automation/flows.mdx`,
24+
`title: Flow Metadata`), and that page does carry the per-node `config` reference, loop and
25+
parallel containers, subflows, waits and error handling that the sentence promises.
26+
27+
Documentation only: no API, behaviour or type surface changes.

‎packages/services/service-automation/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,5 +456,7 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).
456456
## See Also
457457

458458
- [@objectstack/spec/automation](../../spec/src/automation/)
459-
- [Flow Builder Guide](https://docs.objectstack.ai/docs/automation)
460-
- [Trigger Reference](https://docs.objectstack.ai/docs/references/automation)
459+
- [Automation](https://docs.objectstack.ai/docs/automation) — the automation docs section: hooks, flows,
460+
workflows, approvals, webhooks, connectors
461+
- [Automation Protocol](https://docs.objectstack.ai/docs/references/automation) — the complete schema
462+
reference for the automation protocol

0 commit comments

Comments
 (0)