Repository navigation
docs: add FAQ, troubleshooting, integration-testing and wallet guides, and a changelog/release process - #557
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
|
@G-ELM 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
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
Adds four documentation deliverables aimed at integrators, contributors, and operators: an FAQ and troubleshooting guide, a guide to testing integrations locally, a wallet integration guide, and a changelog with a documented release process.
Type of Change
Changes Made
Task 1 — FAQ and developer troubleshooting guide
docs/getting-started/faq.md(15 entries): what Shade is not, supported tokens and networks, fees and the 48h fee time-lock, custody of funds, refunds, fiat pricing, who can pause and upgrade, admin transfer, merchant registration, snapshots, error lookup.docs/getting-started/troubleshooting.md(12 entries, each with symptom / cause / fix and exact error text): missingwasm32target, rustc too old, SDK version mismatch, staleCargo.lock, linker errors,test_snapshots/in git, zero tests running,Error(Auth, InvalidAction),Error(Contract, #N), simulation vs. submission differences, archived entries / TTL, CLI identity and network setup. Includes a "Still stuck?" section linking the issue tracker and the errors reference.docs/getting-started/README.md.Task 2 — Guide to testing integrations locally
docs/guides/testing-integrations.md.shadeandaccountWASMs withcontractimport!, a reusableFixturehelper (SAC test token, hub init, account WASM hash, merchant registration, linked account contract, funded payer), a mock oracle for fiat invoices,try_*error assertions, and an event-assertion helper.stellar container start local, funding identities, deploying the stack, a TypeScript backend test using generated bindings andgetEvents, and resetting state.testutilsfeature orshade-testutilscrate as a follow-up issue.docs/guides/README.md.Task 3 — Wallet integration guide
docs/guides/wallet-integration.md.pay_invoiceflow, contract-error-to-message mapping, and a minimal Vite example app.docs/guides/README.md,accepting-payments.md, andcontract-bindings.md.Task 4 — CHANGELOG and release process
CHANGELOG.md(Keep a Changelog format, entries grouped by contract) with entries backfilled from merged PRs, February–July 2026.docs/operations/releases.md: versioning scheme (coordinated release tags plus per-contract SemVer, and how versions map to tags and WASM hashes), breaking-change criteria (interface signatures, event shapes, error codes, storage layout, behavior), and the release procedure (tagging, reproducible builds, recording hashes, release notes template,gh release create)..github/pull_request_template.mdand a matching item to theCONTRIBUTING.mdchecklists.docs/operations/README.md.Test Evidence
Documentation-only change; no contract code was modified. Code samples were written against the existing test patterns and were not compiled or run in this change.
make testpasses locally (not applicable — no code changes)test_snapshots/file is staged in this PRDocumentation Updates
docs/page and satisfies the Documentation Style Guide's review checklist.README.md.Closes #508
Closes #511
Closes #512
Closes #513