docs: ✍️ Update documentation #133
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors the documentation to improve clarity and organization by moving detailed configuration and architecture information into dedicated files (SETTINGS.md and ARCHITECTURE.md) and consolidating the README to focus on quick-start usage. The changes add comprehensive documentation about Mellow Vaults integration, including visual diagrams explaining deposit/redeem flows and the oracle lifecycle.
Key changes:
- Relocated detailed configuration tables from README.md to SETTINGS.md, replacing with a reference link
- Added extensive Mellow Vaults architecture documentation including three Mermaid diagrams showing vault structure, deposit flow, and redeem flow
- Updated all CLI command examples to use
uv runprefix consistently
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Streamlined by removing detailed configuration tables and development sections, replacing them with references to SETTINGS.md and ARCHITECTURE.md; updated all command examples to use uv run prefix |
| ARCHITECTURE.md | Enhanced with new "How Mellow Vaults Work" section containing Mermaid diagrams, detailed explanations of vault components, deposit/redeem lifecycle, and oracle report lifecycle |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request updates the documentation to provide a clearer, more comprehensive overview of the TQ Oracle architecture and usage. The changes focus on improving explanations of the core pipeline, expanding details on Mellow Vaults and the oracle lifecycle, and restructuring configuration and usage instructions for clarity.