docs: point concept and event links to dedicated pages in hand-written guides#1210
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
dawnho
changed the title
dawnho
force-pushed
the
fix/strip-boilerplate-concept-links-events
branch
from
d320575 to
ec0adee
Compare
dawnho
changed the title
dawnho
force-pushed
the
fix/strip-boilerplate-concept-links-events
branch
from
ec0adee to
033966f
Compare
dawnho
force-pushed
the
fix/strip-boilerplate-concept-links-events
branch
from
033966f to
b4ceb17
Compare
dawnho
changed the title
…n guides
Reviewed the generic concept/event links in the affected hand-written pages and
pointed each at the right dedicated reference now that resource-specific pages
exist:
- Troubleshooting sentences on 4 pages linked "properties/errors/warnings" to
the generic Devices/Thermostats overview (mismatched target). Re-point to the
dedicated device pages: properties -> /api/devices/object, errors or warnings
-> /api/devices/errors ("Device Errors and Warnings"), events ->
/api/devices/events.
- Re-point generic [`resource.event`](/api/events/object) links (42 across 31
pages) to the resource's dedicated events page — lock.* -> /api/locks/events,
thermostat.* -> /api/thermostats/events, connected_account.* ->
/api/connected_accounts/events, device.* -> /api/devices/events,
noise_sensor.* -> /api/noise_sensors/noise_thresholds/events. The canonical
"all event types" links on the webhooks page stay on /api/events/object.
- De-duplicate repeated same-concept links: keep the first, unwrap the rest.
Anchored/sub-path links are left intact.
Scope is non-generated pages only. Concept-link cleanup of the auto-generated
API reference is handled upstream at the source (seamapi/seam-connect#16179).
dawnho
force-pushed
the
fix/strip-boilerplate-concept-links-events
branch
from
b4ceb17 to
1393394
Compare
dawnho
changed the title
…-concept-links-events
Now that the resource events pages and the new per-resource errors pages (locks, thermostats, phones — #1219) exist, link to the specific heading rather than the page top: - Event links whose text names a `resource.event` (e.g. `lock.unlocked`) now point at that event's anchor, e.g. /api/locks/events#lock.unlocked. 35 links. - The capability-troubleshooting sentences' "errors or warnings" links point at /api/devices/errors#device_offline — the specific error behind a non-functional capability (the sentence references `device.properties.online`). device_offline lives only on the device errors page, so this stays device-level and is content-correct. Anchor slugs are the heading's verbatim code (dots/underscores preserved, per existing anchors like #acs_system.errors.seam_bridge_disconnected). All 39 anchors verified against real headings. Merged latest main to pick up the new error pages. Still non-generated pages only.
dawnho
commented
Jul 2, 2026
dawnho
commented
Jul 2, 2026
Mintlify slugs a code heading like `lock.unlocked` as #lock-unlocked (dot -> hyphen, underscores kept), not #lock.unlocked. The dotted anchors failed the Mintlify broken-links/anchors check. Hyphenate the dot in all 35 event deep-link anchors; verified locally with `mintlify broken-links --check-anchors` (no broken links). #device_offline was already valid.
… links - The troubleshooting sentences' generic 'errors or warnings' phrase links to the device errors page, not a specific error (drop #device_offline on all 4 parallel sentences). - Thermostat schedules page: remove the redundant set point and webhook links, keeping the thermostat.temperature_reached_set_point event link.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Point the concept/event/error references in hand-written docs at the right dedicated pages — and, where the link text names a specific event or error, at that item's heading anchor.
Event links → specific event headers (35)
[`lock.unlocked` event](/api/events/object)→[`lock.unlocked` event](/api/locks/events#lock.unlocked). Routed by the event token in the text:lock.*→locks,thermostat.*→thermostats,connected_account.*→connected_accounts,device.*→devices,noise_sensor.*→noise_sensors/noise_thresholds. Generic "event types" links ondeveloper-tools/webhooksstay on the canonical/api/events/object.Error links → specific error header (4)
The capability-troubleshooting sentences' "errors or warnings" links →
/api/devices/errors#device_offline— the specific error behind a non-functional capability (the sentences referencedevice.properties.online).device_offlinelives only on the device errors page, so these stay device-level and content-correct even on the thermostat/lock pages.Troubleshooting sentences
properties→/api/devices/object,events→/api/devices/events(page-level category references), plus the error deep-link above.Dedup
Repeated same-concept links deduped (keep first); anchored/sub-path links preserved.
Correctness
#acs_system.errors.seam_bridge_disconnected.##/###headings on their target pages — zero broken.mainfor the new per-resource error pages (locks/thermostats/phones, feat: generate Errors and Warnings pages for device sub-categories (locks, thermostats, phones) #1219).Scope
Non-generated pages only (37 files; no
api/or codegen). Concept-link cleanup of the auto-generated API reference is handled upstream in seamapi/seam-connect#16179.🤖 Generated with Claude Code