docs: improve documentation, fix broken links, and add parameter desc…#17
Open
phessophissy wants to merge 1 commit into
Open
docs: improve documentation, fix broken links, and add parameter desc…#17phessophissy wants to merge 1 commit into
phessophissy wants to merge 1 commit into
Conversation
…riptions - README.md improvements: - Fixed malformed link to bridge.clar contract - Added table of contents for better navigation - Added protocol overview explaining trustless BTC-xBTC swaps - Added architecture section with swap flow diagrams - Added project structure documentation - Added testing instructions - Added environment variables documentation - Added contributing guidelines - docs/README.md fixes: - Fixed broken links using incorrect '.mdinet/' path - Reorganized into Core Contracts, Supporting Contracts, and External Dependencies - Added contract architecture diagram - Added descriptions for each contract - docs/bridge.md improvements: - Added descriptions for all function parameters that were previously empty - Parameters now include helpful context about types and expected values
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
1 participant
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.
Description
This PR improves documentation quality, fixes broken links, and adds missing parameter descriptions across the Magic Protocol documentation.
Changes
📄 README.md
bridge.clarcontract (was[./contracts/bridge.clar](bridge.clar))yarn test,clarinet test)📄 docs/README.md
.mdinet/path → corrected to./../.clarinet/📄 docs/bridge.md
Example parameter improvements:
txid | (buff 32) |txid | (buff 32) | The 32-byte Bitcoin transaction IDcontroller | principal |controller | principal | The STX address of the supplier controllerhash | (buff 32) |hash | (buff 32) | 32-byte hash (SHA256 of preimage)Motivation
Type of Change
Testing
Checklist