TheAnachronism/tt-rss-viewer
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

README + install docs #67

New issue
Closed
opened 2026-08-04 19:41:08 +00:00 by TheAnachronism · 1 comment
TheAnachronism commented 2026-08-04 19:41:08 +00:00
Owner
Copy link

Parent

Implements contributor entry docs + install/privacy docs from docs/1.0-beta-readiness.md (1.0 beta release readiness).

What to build

Ship docs/install.md and a non-empty README.md so installers and contributors can find the APK path, build locally, and see the privacy must-disclose — without using the word “friend”.

Acceptance criteria

  • docs/install.md covers: get APK from Forgejo Releases (beta/<semver>, tt-rss-viewer-beta-<semver>.apk); install on Android; Sign-in / ENABLE_API_ACCESS prerequisite; how to update via Releases; privacy must-disclose (password + sid on-device; network only to user’s own tt-rss); plain alpha→beta may-need-reinstall note
  • README.md has product one-liner, pointer to docs/install.md, nix + non-nix build paths, short privacy blurb + link to fuller privacy text in install docs
  • Neither doc uses the word “friend”
  • Not required: screenshots, troubleshooting encyclopedia, CONTRIBUTING, architecture tour, Document-band known-issues section in install docs

Blocked by

  • None — can start immediately.
## Parent Implements contributor entry docs + install/privacy docs from [`docs/1.0-beta-readiness.md`](../src/branch/master/docs/1.0-beta-readiness.md) ([1.0 beta release readiness](https://git.anachronis.dev/TheAnachronism/tt-rss-viewer/issues/41)). ## What to build Ship **`docs/install.md`** and a non-empty **`README.md`** so installers and contributors can find the APK path, build locally, and see the privacy must-disclose — without using the word “friend”. ## Acceptance criteria - [ ] `docs/install.md` covers: get APK from Forgejo Releases (`beta/<semver>`, `tt-rss-viewer-beta-<semver>.apk`); install on Android; Sign-in / `ENABLE_API_ACCESS` prerequisite; how to update via Releases; privacy must-disclose (password + `sid` on-device; network only to user’s own tt-rss); plain alpha→beta may-need-reinstall note - [ ] `README.md` has product one-liner, pointer to `docs/install.md`, nix + non-nix build paths, short privacy blurb + link to fuller privacy text in install docs - [ ] Neither doc uses the word “friend” - [ ] Not required: screenshots, troubleshooting encyclopedia, CONTRIBUTING, architecture tour, Document-band known-issues section in install docs ## Blocked by - None — can start immediately.
TheAnachronism commented 2026-08-04 21:12:03 +00:00
Author
Owner
Copy link

Shipped README.md + docs/install.md (no “friend” wording). Closing.

Shipped README.md + docs/install.md (no “friend” wording). Closing.
TheAnachronism removed their assignment 2026-08-06 14:35:35 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
beta/0.0.4
beta/0.0.3
beta/0.0.2
beta/0.0.1
alpha/0.0.2
Labels
Clear labels   
needs-info
Waiting on reporter for more information

  
needs-triage
Maintainer needs to evaluate this issue

  
ready-for-agent
Fully specified, ready for an AFK agent

  
ready-for-human
Requires human implementation

  
wayfinder:grilling
HITL grilling/decision ticket

  
wayfinder:map
Wayfinder effort map

  
wayfinder:prototype
HITL prototype ticket

  
wayfinder:research
AFK research ticket

  
wayfinder:task
Unblocking manual task ticket

  
wontfix
Will not be actioned

No labels
needs-info
needs-triage
ready-for-agent
ready-for-human
wayfinder:grilling
wayfinder:map
wayfinder:prototype
wayfinder:research
wayfinder:task
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
TheAnachronism
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
TheAnachronism/tt-rss-viewer#67
No description provided.