mirror of
https://github.com/tiennm99/miti99bot.git
synced 2026-04-17 13:21:31 +00:00
docs: update all docs to reflect current trading module state
Trading module now VN stocks only with dynamic symbol resolution. Update test counts (105), remove crypto/gold/forex references from project-level docs, update architecture file tree descriptions.
This commit is contained in:
@@ -10,7 +10,7 @@ Modules are added or removed via a single `MODULES` env var. Each module registe
|
||||
- **Three visibility levels out of the box.** Public commands show in Telegram's `/` menu and `/help`; protected show only in `/help`; private are hidden slash-command easter eggs. One namespace, loud conflict detection.
|
||||
- **Storage is swappable.** Modules talk to a small `KVStore` interface — Cloudflare KV today, a different backend tomorrow, with a one-file change.
|
||||
- **Zero admin surface.** No in-Worker `/admin/*` routes, no admin secret. `setWebhook` + `setMyCommands` run at deploy time from a local node script.
|
||||
- **Tested.** 110 vitest unit tests cover registry, storage, dispatcher, help renderer, validators, HTML escaping, and the trading module.
|
||||
- **Tested.** 105 vitest unit tests cover registry, storage, dispatcher, help renderer, validators, HTML escaping, and the trading module.
|
||||
|
||||
## How a request flows
|
||||
|
||||
@@ -54,7 +54,7 @@ src/
|
||||
│ ├── dispatcher.js # wires every command via bot.command()
|
||||
│ ├── validate-command.js
|
||||
│ ├── util/ # /info, /help (fully implemented)
|
||||
│ ├── trading/ # fake paper trading — crypto, stocks, forex, gold
|
||||
│ ├── trading/ # paper trading — VN stocks (dynamic symbol resolution)
|
||||
│ ├── wordle/ # stub — proves plugin system
|
||||
│ ├── loldle/ # stub
|
||||
│ └── misc/ # stub
|
||||
|
||||
Reference in New Issue
Block a user