-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
awCreated by agentic workflowCreated by agentic workflowcode-healthCode cleanup and maintenanceCode cleanup and maintenancedocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Root Cause
The README (README.md lines 201–220) shows the project structure with docs at the top-level docs/ directory:
cli-tools/
├── docs/
│ ├── plan.md
│ ├── architecture.md
│ ├── changelog.md
│ └── implementation.md
```
The actual layout on disk is:
```
cli-tools/
├── docs/
│ └── changelog.md ← only this file is here
└── src/
└── copilot_usage/
└── docs/ ← the other three files live here
├── architecture.md
├── changelog.md
├── implementation.md
└── plan.md
```
A contributor following the README to find the architecture or implementation notes would look in the wrong directory.
## Fix
Update the project structure diagram in `README.md` to reflect the real layout:
```
cli-tools/
├── src/
│ └── copilot_usage/
│ ├── cli.py
│ ├── models.py
│ ├── parser.py
│ ├── pricing.py
│ ├── logging_config.py
│ ├── report.py
│ └── docs/ ← developer docs live here
│ ├── architecture.md
│ ├── changelog.md
│ ├── implementation.md
│ └── plan.md
├── docs/
│ └── changelog.md ← top-level changelog
├── tests/
│ ├── copilot_usage/
│ └── e2e/
├── Makefile
└── pyproject.toml
Testing Requirement
No automated test is needed for a documentation-only fix. Verify manually that the paths shown in the updated diagram match the actual repository layout.
Generated by Code Health Analysis · ◷
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
awCreated by agentic workflowCreated by agentic workflowcode-healthCode cleanup and maintenanceCode cleanup and maintenancedocumentationImprovements or additions to documentationImprovements or additions to documentation