Newer Older
42 lines | 1.446kb
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 2 months ago
17
- `Research Resources/`
18
  External source material plus the notes derived from it.
19

            
20
## Documentation Layers
21

            
22
We keep two distinct layers of documentation:
23

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

            
29
## Retention Rule
30

            
31
Prefer keeping:
32

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

            
38
Avoid committing by default:
39

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