Feat/docs updates - #197
Merged
Merged
Conversation
|
@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! 🚀 |
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
This PR addresses several documentation gaps and recurring questions in the
README.mdto improve the onboarding experience for new contributors and users.Changes included:
progressmetric is reported in basis points (0-10000) and provided an explicit percentage conversion example. Noted that zero-total streams also report full progress.THREAT_MODEL.md.1.84.0in the Building section, noting thatsoroban-sdkrequires a recent toolchain for thewasm32v1-nonetarget.Closes #133
Closes #135
Closes #136
Closes #137