Add error code reference and cross-link troubleshooting guide - #136
Open
Mathew2k-hash wants to merge 1 commit into
Open
Add error code reference and cross-link troubleshooting guide#136Mathew2k-hash wants to merge 1 commit into
Mathew2k-hash wants to merge 1 commit into
Conversation
- 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.
|
@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! 🚀 |
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.
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