Docs/consolidated documentation updates - #289
Merged
levoski1 merged 6 commits intoJul 26, 2026
Merged
Conversation
Add compliance-contract deployment and initialization steps to the ceremony checklist in docs/MAINNET_DEPLOYMENT.md, including admin address handling, initial allowlist state, and compliance-specific admin key handling guidance.
Add a compliance contract section to docs/contract-interaction-guide.md with realistic example transactions for allow_address, block_address, allow_address_until, transfer_admin/accept_admin, and clear_address alongside existing invoice and treasury examples.
Add a comebackhere-frontend-specific walkthrough section to docs/TESTNET_ONBOARDING.md covering browser wallet setup (Freighter/xBull), testnet funding via Friendbot, USDC acquisition, network configuration (soroban.ts env vars), wallet connection steps, and troubleshooting.
Add definitions for grace window, on-hold settlement, dispute quorum, and allowlist (compliance) to docs/glossary.md, keeping tone consistent with existing entries and cross-referencing the relevant contracts.
Add blank lines around lists and code blocks in README.md to satisfy markdownlint rules (MD031, MD032).
|
@Sundriveauto 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
2 participants
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.
Here are commit message options depending on whether you are committing these documentation updates individually or combining them into a single pull request.
Option 1: Individual Commits (Recommended)
docs: add escrow, grace window, and settlement terms to glossary
Updates docs/glossary.md with definitions for core product domain terms used across components and changelogs.
Adds concise definitions for escrow, grace window, on-hold settlement, dispute quorum, and allowlist.
Cross-references corresponding contract modules and route handlers.
docs: document payer wallet setup and testnet config for comebackhere-frontend
Expands docs/TESTNET_ONBOARDING.md to cover browser wallet setup for the comebackhere-frontend payer app.
Documents testnet account funding via Friendbot.
Specifies network passphrase and RPC URL expectations matching src/utils/soroban.ts.
docs: add compliance contract initialization to mainnet deployment checklist
Updates docs/MAINNET_DEPLOYMENT.md to include compliance contract steps in the deployment signing ceremony.
Adds deployment and initialization steps for the compliance contract alongside invoice and treasury.
Outlines compliance-specific admin key management and initial allowlist state setup.
docs: add compliance contract usage examples to interaction guide
Expands docs/contract-interaction-guide.md with invocation examples for the compliance smart contract.
Documents CLI/SDK invocation examples for allow_address, block_address, allow_address_until, and clear_address.
Outlines the two-step transfer_admin and accept_admin ownership transfer workflow matching contracts/compliance/src/lib.r
Closes #272
Closes #273
Closes #275
Closes #276