Add error code reference and cross-link troubleshooting guide - #136
Conversation
|
@Mathew2k-hash Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
|
Thanks @Mathew2k-hash. #135 (nav cleanup) merged and restructured On the conflict, take the new nav tree from develop and re-add your Reference entry into it rather than keeping your old version of the file. |
- Add reference/error-codes.mdx: normative flat tables for Soroban contract errors (#N codes), SDK error messages, CLI error codes, and Soroban RPC/indexer errors. Each row has a stable anchor for Discord and support citations. - Add cross-links from every relevant section in guides/stellar-troubleshooting.mdx back to the matching table row. - Add reference/error-codes to the Reference nav group in docs.json. - Include auto-generation note describing a generate:error-codes script pattern mirroring scripts/generate-stellar-reference.ts.
5f5039a to
3cfb155
Compare
|
I have rebased this onto The only conflict was the Reference group in Verified locally before pushing: Nothing needed from you unless you disagree with where the nav entry landed. If you have a local copy of this branch, |
|
Merged. Thanks for your patience on the rebase @Mathew2k-hash. Pairing the normative table with cross-links back into the troubleshooting guide is what makes both pages more useful rather than redundant. |
Add normative error-code reference and cross-link troubleshooting guide
Fixes the "support keeps re-typing SDK errors in Discord" problem by giving every error a
stable, linkable anchor.
What's new
reference/error-codes.mdx — a new normative reference page with one table per error source:
stealth-sender, and wraith-names — symbolic name, meaning, common cause, and fix for every
variant
(meta-address decoding, key derivation, ECDH edge cases)
invalid_cursor, contract_not_found, ledger_not_found
canonical row in this table
Cross-links added to guides/stellar-troubleshooting.mdx
Top-of-file callout pointing to the new reference, plus inline Reference: lines at sections 7,
13–20 linking directly to the matching table anchor.
Nav
reference/error-codes added as the first entry in the Reference group in docs.json.
Auto-generation note
The page documents a generate:error-codes script pattern (mirroring
scripts/generate-stellar-reference.ts) for keeping contract error tables in sync from
TypeScript bindings once the script is implemented.
Testing
pnpm run check:snippets passes — 60 MDX files, 572 snippets, 0 failures. The new page has no
code fences so it adds no new CI surface.
closes #121