Skip to content

Rewrite README with architecture diagrams and OIF documentation#122

Open
jimmchang wants to merge 3 commits intomainfrom
0xjim/read-me-update
Open

Rewrite README with architecture diagrams and OIF documentation#122
jimmchang wants to merge 3 commits intomainfrom
0xjim/read-me-update

Conversation

@jimmchang
Copy link
Copy Markdown
Member

Summary

  • Rewrites the README to serve as a proper technical reference for the protocol, covering architecture, settler implementations, oracle integrations, solver selection mechanics, and the governance fee model
  • Adds ASCII architecture diagram and sequence flow diagram showing the full cross-chain settlement lifecycle
  • Incorporates OIF standard terminology and dictionary for consistent language across the ecosystem

Test plan

  • Verify README renders correctly on GitHub (ASCII diagrams inside code blocks, tables, links)
  • Confirm all external links resolve (OIF repo, OIF solvers repo, LI.FI docs, Resource Locks docs)
  • Confirm deployed addresses match current production deployments

🤖 Generated with Claude Code

@jimmchang jimmchang requested a review from reednaa March 19, 2026 20:59
Copy link
Copy Markdown
Member

@reednaa reednaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Diagrams are not good. Ranging from outright wrong (reference figma charts) to unhelpful (see state diagram.).

Either use Figma diagrams (pngs.) or Mermaid. Ascii diagrams are not helpful.

@jimmchang jimmchang requested a review from reednaa March 30, 2026 01:50
@reednaa
Copy link
Copy Markdown
Member

reednaa commented Mar 30, 2026

@0xjim I don't see any changes

Copy link
Copy Markdown
Member

@reednaa reednaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unresolved issues.

@jimmchang
Copy link
Copy Markdown
Member Author

Unresolved issues.

@reednaa sorry i had notifications off and didnt see you had a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants