Clarify Doris stack README purpose and runtime

This commit is contained in:
Fizzlepoof
2026-05-16 20:33:31 +00:00
parent 9f614ca0e7
commit ee531c55f3
2 changed files with 101 additions and 32 deletions

View File

@@ -1,6 +1,56 @@
# Doris Dashboard
Local static homepage for Johns morning briefing and peek-anytime news dashboard.
Local homepage for John's briefing, glanceable status, and "what matters right now" view.
## What it is
Doris Dashboard is the quiet front page for John's local information stack on NOMAD. It is not a general website and it is not meant to be another feed reader with a fresh coat of paint. It exists to turn Doris Digest output and a few homelab/task signals into one page John can open for a fast read.
The dashboard is meant to answer:
- what is worth looking at this morning
- what local or homelab signals need attention
- what chores or Paperless follow-ups are still hanging around
- what topics are surfacing too often and should be tuned down
## Why it exists
Without this stack, the raw inputs are noisy:
- Doris Digest candidates are too broad on their own
- Donetick and Paperless are useful but fragmented
- local weather/sky/homelab signals live in separate places
The dashboard turns that into one opinionated, local-only page that Doris can tune over time.
## Runtime model
- **Repo source:** `/home/fizzlepoof/repos/truenas-stacks/home/doris-dashboard`
- **Live runtime:** `/opt/doris-dashboard`
- **Generated page:** `/opt/doris-dashboard/public/index.html`
- **LAN URL:** `http://10.5.1.16:8787/`
- **Exposure rule:** local-only unless John explicitly asks otherwise
## What it shows
- top briefing cards from Doris Digest candidates
- space / homelab / local / other signal lanes
- an experimental `New to You` lane for off-profile category sampling
- Donetick tasks
- Paperless review queue items
- weather, sky, and homelab pulse cards
- lightweight stats about candidate/source mix
## How it works
- `bin/generate_dashboard.py` reads Doris Digest candidates plus a few local/runtime data files.
- It scores, deduplicates, and groups stories into dashboard sections.
- It writes generated JSON artifacts under `data/` and the final static page under `public/`.
- `bin/dashboard_server.py` serves the page and handles interactive actions like topic feedback and Paperless review state.
That means the dashboard is static-looking for the reader, but still has enough local interactivity for feedback and review flows.
## Live paths
Live runtime path:
@@ -8,30 +58,12 @@ Live runtime path:
/opt/doris-dashboard
```
Source path in the homelab repo:
```bash
/home/fizzlepoof/repos/truenas-stacks/home/doris-dashboard
```
Generated page:
```bash
/opt/doris-dashboard/public/index.html
```
## What it shows
- Morning briefing with fleshed-out cards
- Today panel for calendar placeholders
- To-do panel for Donetick/to-do placeholders
- Notes panel
- Sky / Space
- Homelab / Smart Home / Ham Radio
- Local news
- Other signal
- Source/candidate stats
## Generate manually
```bash