Skip to content

[finding] Two link labels in service-automation's published README name pages that are not what they now land on #9668

Description

@claude

Filed by the PM seat (domain:devx) on behalf of the #9632 dev, which measured this but could not file it — GitHub's search API was rate-limited across three attempts and this repo's rule 3 requires a duplicate search before filing. Handing it up rather than filing blind was the right call. Duplicate scan done here instead over all 238 open issues (title + body): no existing card covers it.

The observation

PR #9662 converted seven root-relative docs links in published READMEs to the absolute https://docs.objectstack.ai/docs/... form. Two of them, both in packages/services/service-automation/README.md, have labels that do not match where they now land — the URLs were converted mechanically, which was correct for a spelling fix:

Label Now lands on Page title
Flow Builder Guide the Automation section index Automation
Trigger Reference the automation protocol reference index Automation Protocol — lists every automation schema, not triggers specifically

Both destinations resolve and both are the reasonable section-level targets. Neither label is exact.

Why it was not fixed in PR #9662

Deliberately, and the reasoning should survive into whoever takes this: picking a new destination is a content judgement on a different axis from the card's claim, which was spelling. #9632's dispatch said to report rather than guess when a target's identity is in question, and the dev held that line.

Note in particular: content/docs/references/studio/flow-builder.mdx does exist and looks like an obvious target for "Flow Builder Guide" — but it is a Studio reference, and almost certainly not what a service-automation README means. That is exactly the plausible-but-wrong re-point a mechanical sweep would have made.

Options

  • A — leave as-is. The destinations are defensible section-level targets and the links work. Zero risk.
  • B — relabel in place (e.g. Automation Guide, Automation Protocol Reference) so the label matches the page title. Cheap, honest, no destination change.
  • C — re-point Trigger Reference at a specific trigger page such as references/automation/time-relative-trigger. Only correct if a reader of a service-automation README wants one trigger rather than the schema set — needs someone who knows what that README is for.

PM's weak preference: B. It fixes the mismatch on the axis where the mismatch actually is (the label, not the destination) and requires no judgement about what the README meant. C requires that judgement and should not be taken without it.

⚠️ Sequencing: PR #9662 is open against this same file. Do not dispatch this until it lands, or the two collide on packages/services/service-automation/README.md.

Refs: #9632 · PR #9662 · #9589 / PR #9636 (the same link-form family)


Generated by Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions