From b2e53bcf1800c9239638aa8afa97728da82dc8d5 Mon Sep 17 00:00:00 2001 From: Sasa Junuzovic Date: Fri, 13 Mar 2026 17:17:22 -0700 Subject: [PATCH] docs: fix stale plan.md references - Mark premium estimation as decided against (N/A, not planned) - Update project structure to reflect docs under src/copilot_usage/docs/ - Add logging_config.py and CI workflow files to structure diagram Closes #10 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/copilot_usage/docs/plan.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/src/copilot_usage/docs/plan.md b/src/copilot_usage/docs/plan.md index f6ebfbf..758c575 100644 --- a/src/copilot_usage/docs/plan.md +++ b/src/copilot_usage/docs/plan.md @@ -44,8 +44,8 @@ The main interface. Launches a Rich-based interactive loop in the terminal: - **Active session data** (since last shutdown or session start): event counts from events.jsonl — model calls, user messages, output tokens. Premium requests are NOT available in events.jsonl between shutdowns; estimation approaches TBD. - Reports clearly separate historical and active data — never mix exact and estimated numbers. -**Planned features**: -- Active session premium request estimation — iterate on approaches and validate against `/usage` command output +**Decided against**: +- Active session premium request estimation — multipliers don't map 1:1 to API calls, producing unreliable numbers. Show "N/A" instead. ### Future tool ideas - **repo-health** — audit any repo against project-standards (missing Makefile targets, wrong ruff rules, missing py.typed, etc.) @@ -63,15 +63,14 @@ cli-tools/ ├── .github/ │ ├── dependabot.yml │ └── workflows/ -│ └── ci.yml +│ ├── ci.yml +│ ├── codeql.yml +│ └── dependency-review.yml ├── Makefile ├── pyproject.toml ├── README.md ├── docs/ -│ ├── plan.md # This file -│ ├── architecture.md # System design and data flow -│ ├── changelog.md # Append-only PR history -│ └── implementation.md # Deep-dive into internals +│ └── changelog.md # Repo-level (CI, infra) ├── src/ │ └── copilot_usage/ │ ├── __init__.py @@ -80,7 +79,13 @@ cli-tools/ │ ├── parser.py │ ├── models.py │ ├── report.py -│ └── pricing.py +│ ├── pricing.py +│ ├── logging_config.py +│ └── docs/ # Tool-specific docs +│ ├── plan.md # This file +│ ├── architecture.md +│ ├── changelog.md +│ └── implementation.md └── tests/ ├── copilot_usage/ # Unit tests │ ├── test_cli.py