Update documentation and README files to reflect current CLI structure and features#140
Merged
talos-agent merged 1 commit intomainfrom Jul 29, 2025
Merged
Conversation
- Update main README.md with comprehensive CLI commands table - Add non-interactive mode documentation - Reorganize environment variables into required vs optional - Update Python version requirement to 3.12+ - Create comprehensive CLI documentation for new modules: - docs/cli/proposals.md for governance proposal evaluation - docs/cli/memory.md for memory management operations - docs/cli/arbiscan.md for Arbitrum contract source retrieval - Update src/talos/cli/README.md with all CLI commands and examples - Expand CONTRIBUTING.md with detailed development guidelines - Update docs/cli/overview.md with missing commands - Update docs/getting-started/installation.md with ARBISCAN_API_KEY - Add comprehensive usage examples and error handling documentation Co-Authored-By: talosgma@gmail.com <talosgma@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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.
Update documentation and README files to reflect current CLI structure and features
Summary
This PR comprehensively updates the Talos documentation to accurately reflect the current CLI structure and capabilities. The main changes include:
The documentation now provides complete coverage of all CLI modules and includes practical usage examples, error handling information, and integration details.
Review & Testing Checklist for Human
Recommended test plan: Set up a fresh environment, follow the installation docs, and test each CLI module with the provided examples to ensure everything works as documented.
Diagram
%%{ init : { "theme" : "default" }}%% graph TD README["README.md<br/>Main project documentation"]:::major-edit CLI_README["src/talos/cli/README.md<br/>CLI documentation"]:::major-edit CONTRIBUTING["CONTRIBUTING.md<br/>Development guidelines"]:::major-edit CLI_OVERVIEW["docs/cli/overview.md"]:::minor-edit INSTALL["docs/getting-started/installation.md"]:::minor-edit PROPOSALS["docs/cli/proposals.md<br/>(NEW)"]:::major-edit MEMORY["docs/cli/memory.md<br/>(NEW)"]:::major-edit ARBISCAN["docs/cli/arbiscan.md<br/>(NEW)"]:::major-edit CLI_TWITTER["docs/cli/twitter.md"]:::minor-edit CLI_GITHUB["docs/cli/github.md"]:::minor-edit CLI_MAIN["src/talos/cli/main.py<br/>CLI implementation"]:::context README --> CLI_README CLI_README --> PROPOSALS CLI_README --> MEMORY CLI_README --> ARBISCAN CLI_OVERVIEW --> CLI_TWITTER CLI_OVERVIEW --> CLI_GITHUB CLI_MAIN --> CLI_README subgraph Legend L1["Major Edit"]:::major-edit L2["Minor Edit"]:::minor-edit L3["Context/No Edit"]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#87CEEB classDef context fill:#FFFFFFNotes
Link to Devin run: https://app.devin.ai/sessions/af1d480cf4c942048d902ff91894f2b3
Requested by: @talos-agent