arrow_backRetour aux issues
HafidIdrissi/Time-Tracker
#23
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
Débutant
Ouvrirarrow_forward
Add an architecture and local data-flow guide
ecoDébutant
documentation
help wanted
good first issue
descriptionDescription
## User problem
New contributors can see the file list but do not have one concise explanation
of how a Windows sample becomes a database period, dashboard metric, and offline
HTML report. This increases the risk of changing the wrong layer or bypassing a
privacy boundary.
## Expected result
Create a short contributor-focused architecture guide and link it from the
README and contributing guide.
## Likely files
- a new `docs/ARCHITECTURE.md`
- `README.md`
- `CONTRIBUTING.md`
## Acceptance criteria
- Describe the flow from `WindowsActivityProvider` to `ActivityTracker`,
`ActivityDatabase`, reporting, categories, and analytics.
- Explain the UI worker thread and message queue at a high level.
- Identify which module owns sampling, transitions, persistence, clipping,
categorization, and rendering.
- Document local storage paths for source and installed execution.
- Highlight privacy boundaries: no network, titles may be sensitive, and tests
must use synthetic data.
- Include a compact text or Mermaid diagram that renders correctly on GitHub.
- Keep the guide implementation-oriented and under roughly 1,200 words.
## Validation
```powershell
python -m unittest discover -v
git diff --check
```
Issues similaires
calkit/calkit
star53
Poids du dépôt moyen
VS Code extension should be robust to YAML parser errors
Seeing this error: ``` Failed to read calkit.yaml: YAMLParseError: A block sequence may not be used as an implicit map…
Python
bug
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: a manual Refresh control
The dashboard polls: `refreshStats()` (`src/doberman/dash/app.py:408`) every 5 s and `refreshPending()` (`:546`) every …
Python
enhancement
good first issue
fu351/Doberman-Core
star211
Poids du dépôt léger
dash: "Copy details" button on each pending-approval card
Each pending-approval card in the dashboard (`renderPending`, `src/doberman/dash/app.py:448-544`) shows the risk badge,…
Python
enhancement
good first issue