Newer Older
44 lines | 1.572kb
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 2 months ago
15
- `Project Structure and Naming.md`
16
  Naming and file-organization rules for views, features, components, and subviews.
Bogdan Timofte authored a month ago
17
- `External Contributions.md`
18
  Log of contributions from external collaborators, with technical evaluation per intervention.
Bogdan Timofte authored 2 months ago
19
- `Research Resources/`
20
  External source material plus the notes derived from it.
21

            
22
## Documentation Layers
23

            
24
We keep two distinct layers of documentation:
25

            
26
- project documentation
27
  Notes that describe our app, decisions, assumptions, and roadmap
28
- research documentation
29
  Vendor manuals, software archives, contact sheets, protocol notes, and model-specific findings
30

            
31
## Retention Rule
32

            
33
Prefer keeping:
34

            
35
- small curated Markdown notes
36
- raw manuals and reference PDFs
37
- small software artifacts that are directly useful for reverse engineering
38
- one canonical copy of each vendor artifact line
39

            
40
Avoid committing by default:
41

            
42
- very large archives with low immediate value
43
- duplicate files already represented elsewhere
44
- generated exports that can be reproduced from a kept source