Website: the docs for each version, not only the latest #59

Open
opened 2026-10-06 15:35:05 +00:00 by twisla · 0 comments
Owner

Idea

A visitor with an older firmware reads the docs that match it (#12, Q181, Q186).

Why

The docs describe the latest version. Someone running v0.9.0 may find a feature that isn't there, or a key that moved.

What's known

  • The docs are in the repository, so every tag has its own copy: a build per release is possible.
  • It multiplies what's published and what has to be checked (links, screenshots). A "since v0.11.0" note on the page that changed is a cheaper first step.

Questions

  1. Is a per-page "since" note enough?
  2. If not, which versions are kept, and how are old pages marked?

Related

#12, docs/milestones/W1.md.

## Idea A visitor with an older firmware reads the docs that match it (#12, Q181, Q186). ## Why The docs describe the latest version. Someone running v0.9.0 may find a feature that isn't there, or a key that moved. ## What's known - The docs are in the repository, so every tag has its own copy: a build per release is possible. - It multiplies what's published and what has to be checked (links, screenshots). A "since v0.11.0" note on the page that changed is a cheaper first step. ## Questions 1. Is a per-page "since" note enough? 2. If not, which versions are kept, and how are old pages marked? ## Related #12, `docs/milestones/W1.md`.
twisla added this to the W1 Website milestone 2026-10-06 15:35:05 +00:00
twisla added the
kind
feature
status
needs-design
priority
low
area/website
labels 2026-10-06 15:35:05 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: twisla/roro9stack#59