mirror of
https://github.com/acamarata/fajr-watch.git
synced 2026-06-30 18:54:27 +00:00
chore: align repository structure with portfolio documentation standards
This commit is contained in:
parent
0040189ba3
commit
5c2014f129
3 changed files with 43 additions and 0 deletions
20
.github/wiki/Architecture.md
vendored
Normal file
20
.github/wiki/Architecture.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Architecture
|
||||
|
||||
Fajr Watch is designed as a field appliance. The operator should be able to configure the station, leave it running, and recover useful twilight observations without managing a general-purpose server.
|
||||
|
||||
## Components
|
||||
|
||||
- `config/station.example.yaml` defines the station identity, coordinates, camera settings, upload target, and capture schedule.
|
||||
- `src/` contains the Python package used by the appliance.
|
||||
- `data/captures/` stores raw field captures and is intentionally kept out of git.
|
||||
- `data/processed/` stores derived outputs and is intentionally kept out of git.
|
||||
- `data/upload-queue/` holds pending records for later transfer.
|
||||
|
||||
## Operating Model
|
||||
|
||||
The station runs scheduled captures around expected Fajr and Isha windows. Captures are kept locally first so network failures do not destroy observations. Review and upload steps should treat raw captures as source data and derived records as reproducible outputs.
|
||||
|
||||
## Configuration Boundary
|
||||
|
||||
`config/station.example.yaml` is the committed template. A real station uses `config/station.yaml`, which is gitignored because it can contain location-specific and deployment-specific values.
|
||||
|
||||
13
.github/wiki/Home.md
vendored
Normal file
13
.github/wiki/Home.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Fajr Watch Wiki
|
||||
|
||||
Fajr Watch is a Raspberry Pi appliance for recording Fajr and Isha twilight observations. It combines a fixed field station, scheduled capture, local configuration, and an upload queue for reviewed observation data.
|
||||
|
||||
## Pages
|
||||
|
||||
- [Architecture](Architecture.md)
|
||||
|
||||
## Repository Docs
|
||||
|
||||
- [Hardware BOM](https://github.com/acamarata/fajr-watch/blob/main/.github/docs/hardware/BOM.md)
|
||||
- [Ship Kit](https://github.com/acamarata/fajr-watch/blob/main/.github/docs/hardware/SHIP-KIT.md)
|
||||
- [Hosting Guide](https://github.com/acamarata/fajr-watch/blob/main/.github/docs/hosting/HOST-GUIDE.md)
|
||||
10
CHANGELOG.md
Normal file
10
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- Initial project structure
|
||||
Loading…
Reference in a new issue