docs: fix project structure tree and add examples reference#15
Open
mrnetwork0001 wants to merge 1 commit into
Open
Conversation
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 updates the README documentation to match the current state of the repository.
Changes
Fixed project structure tree: Removed references to v1 contract directories (
message-transmitter/andtoken-messenger-minter/) that don't exist in the repo. The repository only contains v2 contracts.Added
examples/to project tree: The examples directory was missing from the project structure diagram despite containing substantial documentation and working bridge scripts.Added Examples section: Added a dedicated section in the main README linking to
examples/README.md, which documents the Stellar↔EVM USDC transfer CLI tool.Motivation
As a new developer exploring this repo, I noticed the project structure in the README doesn't match the actual file layout. The references to v1 contracts (
message-transmitter/,token-messenger-minter/) that don't exist can be confusing during onboarding. Additionally, the excellent examples documentation was not discoverable from the main README.Testing
message-transmitter/andtoken-messenger-minter/directories do NOT exist