docs: rewrite README.md following technical writer persona#77
docs: rewrite README.md following technical writer persona#77
Conversation
Rewrote the README.md to follow best practices for developer documentation based on the Divio System and Technical Writer constraints. Changes include: - Clear separation of 'Why This Exists', 'Quick Start', and 'Installation'. - Updated setup instructions and environment variable explanations. - Comprehensive list and categorization of Telegram bot commands. - Consistent voice (second person, active) and clean markdown formatting.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
There was a problem hiding this comment.
Pull request overview
This PR rewrites README.md to improve developer-facing documentation structure and clarity (Quick Start/Installation/Configuration) and to expand the Telegram command reference for the trading bot.
Changes:
- Added an npm version badge and refreshed the project introduction.
- Reworked setup instructions (Quick Start + Installation + env var configuration).
- Expanded and re-categorized the Telegram command reference (analysis, ML/AI, trading, alerts, UI).
| 1. Clone the repository | ||
| ```bash | ||
| # 1. Clone the repository | ||
| git clone https://github.com/yourusername/crypto-signal-bot.git | ||
| cd crypto-signal-bot | ||
| git clone https://github.com/rab781/RabTradebot.git | ||
| cd RabTradebot | ||
| ``` |
There was a problem hiding this comment.
The fenced code blocks under the numbered Installation steps aren’t indented, so GitHub Markdown will typically break the list formatting (the code blocks render outside the list). Indent the ``` fences/content (or switch the steps to headings) so each code block is nested under its list item.
There was a problem hiding this comment.
Fixed in c7fae74. Each code block under the numbered Installation steps is now indented by 3 spaces and preceded by a blank line, so GitHub Markdown correctly renders them as nested within their list items.
| ### ML & AI | ||
| - `/mlpredict [symbol]` - GRU-based LSTM price prediction | ||
| - `/trainmodel [symbol] [epochs]` - Train ML model (e.g., `/trainmodel BTCUSDT 15`) | ||
| - `/mlstatus` - Check ML model status |
There was a problem hiding this comment.
/mlstats is implemented (see bot.command('mlstats', ...)), but it’s missing from this command reference even though /stats points users to it for detailed ML performance. Consider adding /mlstats [symbol] under “ML & AI” (or “Data & Status”) to keep the reference accurate.
| - `/mlstatus` - Check ML model status | |
| - `/mlstatus` - Check ML model status | |
| - `/mlstats [symbol]` - Detailed ML performance statistics |
Disabled the `@typescript-eslint/no-var-requires` eslint rule on line 239 of `src/services/bayesianOptimizer.ts` using an inline comment. This resolves the specific error that was causing the CI job `test (20.x)` to fail with exit code 1.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/rab781/RabTradebot/sessions/17430185-66d3-4302-a805-6e979b185939 Co-authored-by: rab781 <149395358+rab781@users.noreply.github.com>
Ran `npm install` to sync the `package.json` with `package-lock.json` and resolve the `npm ci` failures in the GitHub Actions workflow where missing `pg` packages were reported.
⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.