Skip to content

docs: add troubleshooting guide#636

Merged
Vera3289 merged 1 commit into
Vera3289:mainfrom
devAgatha:feature/troubleshooting-docs-522
Jun 27, 2026
Merged

docs: add troubleshooting guide#636
Vera3289 merged 1 commit into
Vera3289:mainfrom
devAgatha:feature/troubleshooting-docs-522

Conversation

@devAgatha

Copy link
Copy Markdown
Contributor

Summary

Adds comprehensive troubleshooting documentation for PayStream, resolving #522.

Changes

  • docs/troubleshooting.md covering all acceptance criteria:
    • Common contract error codes (AlreadyInitialized, Unauthorized, StreamNotFound, InvalidState, NothingToWithdraw, etc.) with causes and resolutions
    • Stellar/Soroban network error reference (txInsufficientFee, HOST_OBJECT_NO_SUCH_OBJECT, ExceededLimit, etc.)
    • FAQ with 10 common questions
    • Known issues tracker (KI-001 to KI-003)
    • Recovery procedures for stuck streams, wrong employee address, accidental cancellation
    • Debug logging guide with Soroban diagnostic events and XDR decoding commands
    • Performance troubleshooting for fees, latency, and batch size limits
    • Support contacts (GitHub Issues, Discussions, security email)

Acceptance Criteria

  • Common error codes explained
  • FAQ section
  • Known issues tracking
  • Recovery procedures
  • Support contact information
  • Debug logging guide
  • Performance troubleshooting

Closes #522

Comprehensive troubleshooting documentation covering:
- Common contract error codes with causes and resolutions
- Stellar/Soroban network error reference
- FAQ (10 common questions)
- Known issues tracker (KI-001 to KI-003)
- Recovery procedures for stuck streams, wrong addresses, accidental cancellation
- Debug logging with Soroban diagnostic events and XDR decoding
- Performance troubleshooting for fees, latency, and batch size limits
- Support contact information

Closes Vera3289#522
@drips-wave

drips-wave Bot commented Jun 26, 2026

Copy link
Copy Markdown

@devAgatha 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! 🚀

Learn more about application limits

@Vera3289 Vera3289 merged commit 5917ce0 into Vera3289:main Jun 27, 2026
5 of 15 checks passed
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.

Create Troubleshooting Documentation

2 participants