Skip to content

Feat/docs updates - #197

Merged
Glittersup merged 4 commits into
TricklePay:mainfrom
Greymantron:feat/docs-updates
Aug 30, 2026
Merged

Feat/docs updates#197
Glittersup merged 4 commits into
TricklePay:mainfrom
Greymantron:feat/docs-updates

Conversation

@Greymantron

Copy link
Copy Markdown
Contributor

Summary

This PR addresses several documentation gaps and recurring questions in the README.md to improve the onboarding experience for new contributors and users.

Changes included:

  • Progress Basis Points: Clarified that the progress metric is reported in basis points (0-10000) and provided an explicit percentage conversion example. Noted that zero-total streams also report full progress.
  • Troubleshooting Section: Added a new section documenting common compilation and deployment errors (wrong target, missing toolchain component, unfunded identity) along with their respective fixes.
  • FAQ Section: Addressed 5 frequently asked questions regarding the contract's architecture, such as why funds are locked up front, what happens if off-chain servers disappear, and the lack of an admin freeze capability. These answers are linked directly to THREAT_MODEL.md.
  • MSRV Clarification: Explicitly stated the Minimum Supported Rust Version (MSRV) as 1.84.0 in the Building section, noting that soroban-sdk requires a recent toolchain for the wasm32v1-none target.

Closes #133
Closes #135
Closes #136
Closes #137

@drips-wave

drips-wave Bot commented Aug 30, 2026

Copy link
Copy Markdown

@Greymantron 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

@Glittersup
Glittersup merged commit cbfe970 into TricklePay:main Aug 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants