Skip to content

docs(service-automation): See Also names the two docs pages it lands on (#9668)#9749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-steve merged 1 commit into from
Aug 18, 2026
+31 −2
Merged

docs(service-automation): See Also names the two docs pages it lands on (#9668) #9749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .changeset/automation-readme-link-labels.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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.
6 changes: 4 additions & 2 deletions packages/services/service-automation/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Loading