Skip to content

Rewrite protocol docs: add Relay Chain, Allocator, Mermaid diagrams, …#237

Open
ptrwtts wants to merge 3 commits intomainfrom
peter-protocol-v2
Open

Rewrite protocol docs: add Relay Chain, Allocator, Mermaid diagrams, …#237
ptrwtts wants to merge 3 commits intomainfrom
peter-protocol-v2

Conversation

@ptrwtts
Copy link
Collaborator

@ptrwtts ptrwtts commented Feb 6, 2026

…and legal language fixes

Complete rewrite of the Settlement Protocol documentation section:

  • Add Relay Chain documentation (Chain ID 537713, Sovereign Stack, Celestia DA)
  • Add Allocator component docs (MPC chain signatures, Payload Builders)
  • Restructure from flat component pages to narrative-driven architecture
  • Add comprehensive flow walkthroughs (Execution, Settlement, Withdrawal, Revert)
  • Add 8 inline Mermaid sequence diagrams with interactive zoom/pan
  • Add Design Principles and Security & Audits pages
  • Add solver and app integration guides
  • Consolidate contract references and addresses
  • Separate Vaults as distinct protocol section
  • Apply legal language fixes (crosschain, revert, destination, asset terminology)
  • Add 13 URL redirects for old pages
  • Delete 8 obsolete files

…and legal language fixes

Complete rewrite of the Settlement Protocol documentation section:
- Add Relay Chain documentation (Chain ID 537713, Sovereign Stack, Celestia DA)
- Add Allocator component docs (MPC chain signatures, Payload Builders)
- Restructure from flat component pages to narrative-driven architecture
- Add comprehensive flow walkthroughs (Execution, Settlement, Withdrawal, Revert)
- Add 8 inline Mermaid sequence diagrams with interactive zoom/pan
- Add Design Principles and Security & Audits pages
- Add solver and app integration guides
- Consolidate contract references and addresses
- Separate Vaults as distinct protocol section
- Apply legal language fixes (crosschain, revert, destination, asset terminology)
- Add 13 URL redirects for old pages
- Delete 8 obsolete files

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Visual diagram showing the three chain roles in the protocol (Origin,
Relay Chain, Destination) with components, actors, and cost annotations.
Uses inline HTML/CSS for full visual control with brand purple styling,
dark mode support, and responsive mobile layout.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Move Relay Chain into Components group, add Security Council and MPC Signing pages
- Consolidate MPC content back into Allocator page
- Create Contracts sidebar group (Addresses, EVM/SVM Depository Reference)
- Rewrite Overview with 5 key dimensions (Speed, Cost, Capital Efficiency, Coverage, UX)
- Restructure How It Works into Architecture + Flows sections with Mermaid diagrams
- Add settlement flow image to Overview
- Remove Design page, absorb relevant content into Overview
- Update solver guide for direct protocol integration (not API)
- Expand Addresses page with Relay Chain and Aurora contract placeholders
- Update Security page to link to Security Council component
- Clean up cross-references and internal links

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant