Newer Older
52 lines | 2.3kb
Bogdan Timofte authored 2 months ago
1
# Documentation
2

            
3
This folder contains project notes, platform decisions, and collected reverse engineering material.
4

            
5
It is intended to keep the repository root focused on the app itself while preserving project context in one dedicated place.
Bogdan Timofte authored 2 months ago
6

            
7
## Working Layout
8

            
9
- `Project History.md`
10
  Narrative context and decisions that explain how the project got here.
11
- `Platform Decision - iOS 15.md`
12
  App-level platform choices that affect implementation.
Bogdan Timofte authored a month ago
13
- `Charging While Off.md`
14
  Definition + measurement implications for capacity estimation.
Bogdan Timofte authored a month ago
15
- `Charge Session Integrity and Conflict Healing.md`
16
  The one-active-session-per-meter invariant, how it can be violated in offline sync scenarios, the healing mechanism, and what is not yet covered.
Bogdan Timofte authored a month ago
17
- `Powerbank Category.md`
18
  Powerbank as a first-class entity (input + output sides), unified source picker, dual-subject checkpoints with percent/bars/none reporting, and view-time derived metrics (voltage profile, max power, efficiency, apparent capacity).
Bogdan Timofte authored 2 months ago
19
- `Project Structure and Naming.md`
20
  Naming and file-organization rules for views, features, components, and subviews.
Bogdan Timofte authored a month ago
21
- `External Contributions.md`
22
  Log of contributions from external collaborators, with technical evaluation per intervention.
Bogdan Timofte authored 2 weeks ago
23
- `API Reference/`
24
  Agent-facing specifications for entities, operations, invariants, UI alignment, storage, sync, and test expectations.
Bogdan Timofte authored 2 months ago
25
- `Research Resources/`
26
  External source material plus the notes derived from it.
27

            
28
## Documentation Layers
29

            
30
We keep two distinct layers of documentation:
31

            
32
- project documentation
33
  Notes that describe our app, decisions, assumptions, and roadmap
Bogdan Timofte authored 2 weeks ago
34
- API reference
35
  Contract-style behavior specifications used to keep agents and contributors aligned with expected app behavior
Bogdan Timofte authored 2 months ago
36
- research documentation
37
  Vendor manuals, software archives, contact sheets, protocol notes, and model-specific findings
38

            
39
## Retention Rule
40

            
41
Prefer keeping:
42

            
43
- small curated Markdown notes
44
- raw manuals and reference PDFs
45
- small software artifacts that are directly useful for reverse engineering
46
- one canonical copy of each vendor artifact line
47

            
48
Avoid committing by default:
49

            
50
- very large archives with low immediate value
51
- duplicate files already represented elsewhere
52
- generated exports that can be reproduced from a kept source