docs: Simplify instructions by separating installation from usage #1052
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #1051
- Create docs/USAGE.md with consolidated usage instructions for CLI and Telegram bot - Restructure README.md to focus on installation options with cleaner structure - Update docs/DOCKER.md to focus on Docker installation, link to USAGE.md - Update docs/HELM.md to focus on Kubernetes/Helm installation, link to USAGE.md The documentation now follows a clear separation: - Installation options (VM, Docker, Helm) stay in their respective docs - Usage instructions (CLI, Telegram bot) are unified in USAGE.md - No more duplication of usage instructions across installation docs 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
konard
changed the title
Fix CI validate-docs check by ensuring README has required sections: - Rename "Installation" to "Quick Start" - Add "Configuration" section with link to CONFIGURATION.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This reverts commit 67f2142.
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
|
I think we did to much deletion, I wanted just reorganize the README.md, so it will be simplier and less duplication with clear first installation and usage steps. We can have separate USAGE.md, but we still need commands to install and use in the README.md. So basic solve usage, start of telegram bot, and installation steps for docker and VM should be in README.md Make sure no content is deleted, double check everything is consistent with the codebase. |
|
🤖 AI Work Session Started Starting automated work session at 2026-01-01T02:54:31.831Z The PR has been converted to draft mode while work is in progress. This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback. |
Restored previously removed content to README.md to ensure it contains: - Basic solve usage examples and options - Full Telegram bot setup with commands (/solve, /hive, /limits, /help) - Complete Docker and Ubuntu 24.04 server installation steps - All 7 installation steps including authentication - Codex sign-in instructions - solve and hive options tables - Usage examples and session management - File size enforcement section Also restored content to docs/DOCKER.md and docs/HELM.md: - Added back Step 5 verification and more CI/CD details - Restored Telegram bot running section in HELM.md Addresses feedback that too much content was deleted in previous iteration. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
|
Can we minimize changes by keeping emojies? Ensure all changes are correct, consistent and fully meet the requirements. |
|
🤖 AI Work Session Started Starting automated work session at 2026-01-01T04:23:25.514Z The PR has been converted to draft mode while work is in progress. This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback. |
Restores all emojis from the original README.md that were accidentally removed during the documentation reorganization: README.md: - 🧠 in title -⚠️ in WARNING sections - 🚀 in Quick Start - ✅ in Docker and Helm benefits lists - 📋 in Core Components - 🔧 in solve/hive Options - 📖 in full options list references - 🤖 in Telegram Bot section - ✅ in Telegram Bot features - 🏗️ in Architecture - → in data flow diagrams - 📊 in Usage Examples - 🔍 in Monitoring & Logging - 🐛 in Reporting Issues - 🛡️ in File Size Enforcement - 📄 in License - 🏆 in Best Practices - 🤖 in Contributing docs/DOCKER.md: - ✅ in authentication benefits lists This minimizes the diff with the original while keeping the structural improvements requested in issue #1051. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
Summary
This PR reorganizes the documentation structure to improve clarity while keeping essential content in README.md as requested.
Changes Made
README.md - Reorganized with full essential content:
Created
docs/USAGE.md- A comprehensive usage guide covering:solveandhivecommands) with examplesUpdated
docs/DOCKER.md:Updated
docs/HELM.md:Benefits
Test Plan
Fixes #1051
🤖 Generated with Claude Code