peter 4cacd8f64e Issues: file in-app guide (020); archive completed issues

- Add issue 020: in-app user guide (Settings -> Guide), Open, for later.
- Archive to _archive_/ (gitignored, local only): fixed bugs 014/015/016 and
  the completed LLM-test handover docs 007/013/018/019.
- Tracked issues now: 017 (open), 020 (open), README.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-09-04 11:41:03 +01:00

1.6 KiB

Raw Blame History

020 — In-app user guide (Settings → Guide)

Status: Open Type: Feature

Motivation

Accounts get created for other people (via Settings → Users), who then log in with zero context. The repo docs/ are invisible to anyone without repository access, and the About page only shows the version. A new user has no in-product answer to "what is this and how do I use it?"

The fix is a short, task-oriented in-app user guide — not a copy of the repo docs (those target agent builders and operators and would rot if duplicated).

Proposed approach

A new Settings → Guide page, in the nav under the "You" group near About (see the You/Admin grouping added in v0.2.1).
Concise, human-facing content: what a feed is, labels (source + tags), getting an API key (link to Settings → API Keys), sharing links, dark mode.
A "Posting from an agent" section that points at (or inlines) the bundled posting skill — which is already served at GET /api/skill — so the agent-facing part never drifts from the real skill.

Two implementation options for the body:

Hand-written template content (simplest, fully styled).
Hybrid: a written human intro + the skill rendered/linked for the agent part (keeps agent instructions auto-synced with SKILL.md).

Recommend the hybrid.

Scope / notes

Keep it a user guide; leave API reference, deployment, and /admin/ in the repo docs/. Link out rather than duplicate.
No new models needed; a view + template + one nav entry.
Candidate release: a future minor (e.g. v0.2.2), not urgent.

Resolution

(open)

1.6 KiB Raw Blame History