Skip to content

[AI] docs(sync): cross-link troubleshooting sections to shape-handle deletion taxonomy - #4750

Open
dikshit-n wants to merge 1 commit into
electric-sql:mainfrom
dikshit-n:docs/crosslink-troubleshooting-to-shape-deletion
Open

[AI] docs(sync): cross-link troubleshooting sections to shape-handle deletion taxonomy#4750
dikshit-n wants to merge 1 commit into
electric-sql:mainfrom
dikshit-n:docs/crosslink-troubleshooting-to-shape-deletion

Conversation

@dikshit-n

@dikshit-n dikshit-n commented Aug 4, 2026

Copy link
Copy Markdown

Summary

PR #4097 (merged 2026-08-03) added a "Why shape handles get deleted" taxonomy in website/docs/sync/guides/shapes.md. Users hitting 409 responses in the troubleshooting guide benefit from a direct path to that taxonomy.

This PR adds two reciprocal cross-links in website/docs/sync/guides/troubleshooting.md:

  1. End of the "Unexpected 409 — why is my shape handle invalid?" section: points to the full taxonomy (replication slot, schema, eviction, explicit API, client-side behavior).
  2. End of the "Replication slot recreation — why are all clients resyncing after a crash?" section: points to the broader taxonomy (replication slot or timeline, schema, eviction, explicit API).

Docs-only change, no behavior modification, no schema change. Follows up on @alco's 2026-08-03 invitation on issue #2680 ("@dikshit-n I have merged @fru1tworld's PR. Feel free to suggest further improvements if you have any").

Changes

  • website/docs/sync/guides/troubleshooting.md: +4 lines, -0 lines
    • +1 link after L170 ("Unexpected 409" section)
    • +1 link after L416 ("Replication slot recreation" section)

Testing

  • Verified the anchor why-shape-handles-get-deleted resolves to the new section in shapes.md (VitePress auto-generates anchors from heading text).
  • No code paths affected; docs-only.
  • The cross-links use the same /docs/sync/guides/shapes#why-shape-handles-get-deleted path style as the existing See the troubleshooting guide link in PR Document why shape handles get deleted #4097, so the link shape is consistent with the new section's outbound references.

AI Usage Disclosure

The initial implementation was drafted with Claude and then reviewed, edited, and tested by me.

Checklist

Related


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

…ion taxonomy

PR electric-sql#4097 (merged 2026-08-03) added a 'Why shape handles get deleted'
taxonomy in website/docs/sync/guides/shapes.md. Users hitting 409
responses in the troubleshooting guide benefit from a direct path to
that taxonomy.

This commit adds two reciprocal cross-links in
website/docs/sync/guides/troubleshooting.md:

1. End of 'Unexpected 409 — why is my shape handle invalid?' section:
   points to the full taxonomy (replication slot, schema, eviction,
   explicit API, client-side behavior).
2. End of 'Replication slot recreation — why are all clients
   resyncing after a crash?' section: points to the broader taxonomy
   (replication slot or timeline, schema, eviction, explicit API).

Docs-only change, no behavior modification, no schema change.
Follows up on @alco's 2026-08-03 invitation on issue electric-sql#2680
('@dikshit-n I have merged @fru1tworld's PR. Feel free to suggest
further improvements if you have any').

Total: +4 lines, 1 file, 0 deletions.
@netlify

netlify Bot commented Aug 4, 2026

Copy link
Copy Markdown

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 407b05b
🔍 Latest deploy log https://app.netlify.com/projects/electric-next/deploys/6a7152302c9fdb0008ebf016
😎 Deploy Preview https://deploy-preview-4750--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant