Contributor and user docs bar #51

New issue

Closed

opened 2026-08-03 22:43:02 +00:00 by TheAnachronism · 1 comment

TheAnachronism commented

2026-08-03 22:43:02 +00:00

Owner

Part of #41

Question

Beyond friend install/update instructions, what README and supporting docs must exist for 1.0 beta (contributor orientation, glossary pointers, how to build)?

Part of #41 ## Question Beyond friend install/update instructions, what README and supporting docs must exist for 1.0 beta (contributor orientation, glossary pointers, how to build)?

TheAnachronism added the

wayfinder:grilling

label

2026-08-03 22:43:02 +00:00

TheAnachronism self-assigned this

2026-08-04 19:04:47 +00:00

TheAnachronism commented

2026-08-04 19:07:16 +00:00

Author

Owner

Resolution

Contributor / user docs bar for sideload-to-friends 1.0 beta (criteria only — write later):

Must — README.md

Product one-liner — Flutter Android client for self-hosted Tiny Tiny RSS (friends sideload beta).
Friend install pointer — link to wherever Friend install and update docs lands; do not duplicate install/update steps in the README.
How to build — both:
- nix develop + one Android Flutter run/build command (per flake hints)
- a non-nix Flutter path (flutter pub get / flutter run / flutter build apk equivalent)
Privacy callout — short blurb that the app stores password + sid for transparent re-login (ADR-0001) and talks to the user’s tt-rss instance over the network, plus a link to the fuller friend-facing privacy text owned by Privacy surface for friends / friend docs.

Not must for beta

CONTRIBUTING.md (or equivalent full contributor pack)
Architecture tour / glossary restatement in README
Doc-map links to CONTEXT.md / docs/mvp-spec.md / docs/adr/ (those stay available as-is; README need not index them)
Agent-skills docs (AGENTS.md / docs/agents/) as a readiness gate

Why

Friends + occasional contributors need an entry surface that isn’t an empty README, without turning beta into a docs project. Install depth and privacy depth stay with their packaging tickets; existing domain/spec/ADR docs already serve deeper orientation.

## Resolution **Contributor / user docs bar** for sideload-to-friends **1.0 beta** (criteria only — write later): ### Must — README.md 1. **Product one-liner** — Flutter Android client for self-hosted Tiny Tiny RSS (friends sideload beta). 2. **Friend install pointer** — link to wherever [Friend install and update docs](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/56) lands; do not duplicate install/update steps in the README. 3. **How to build** — both: - `nix develop` + one Android Flutter run/build command (per flake hints) - a non-nix Flutter path (`flutter pub get` / `flutter run` / `flutter build apk` equivalent) 4. **Privacy callout** — short blurb that the app stores password + `sid` for transparent re-login (ADR-0001) and talks to the user’s tt-rss instance over the network, plus a link to the fuller friend-facing privacy text owned by [Privacy surface for friends](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/55) / friend docs. ### Not must for beta - `CONTRIBUTING.md` (or equivalent full contributor pack) - Architecture tour / glossary restatement in README - Doc-map links to `CONTEXT.md` / `docs/mvp-spec.md` / `docs/adr/` (those stay available as-is; README need not index them) - Agent-skills docs (`AGENTS.md` / `docs/agents/`) as a readiness gate ### Why Friends + occasional contributors need an entry surface that isn’t an empty README, without turning beta into a docs project. Install depth and privacy depth stay with their packaging tickets; existing domain/spec/ADR docs already serve deeper orientation.

TheAnachronism closed this issue

2026-08-04 19:07:16 +00:00

TheAnachronism referenced this issue

2026-08-04 19:07:16 +00:00

1.0 beta release readiness #41

TheAnachronism referenced this issue

2026-08-04 19:19:46 +00:00

Privacy surface for friends #55

TheAnachronism referenced this issue

2026-08-04 19:23:53 +00:00

Friend install and update docs #56