mittwald / mittwald/flow

Releases page: link the GitHub Atom feed and expose it for autodiscovery

Open Beginner friendly
#3,012 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
TypeScript
Stars
15
Forks
3
Avg merge
1d 17h
Merged PRs (30d)
184

Description

The /releases page offers no way to subscribe. Add a visible link to
https://github.com/mittwald/flow/releases.atom plus a
<link rel="alternate" type="application/atom+xml"> so feed readers discover it
automatically.

Scope

  • Visible subscribe link in the intro Section of
    apps/docs/src/app/releases/page.tsx. German UI text — the docs site stays
    German.
  • Autodiscovery through the page's existing export const metadata:
    alternates.types["application/atom+xml"]. Next.js emits the
    <link rel="alternate"> from it, so no manual <head> handling.

What subscribers get — and how it differs from the page

GitHub's feed is not the curated timeline. Verified against the live feed on
2026-08-31:

  • No query parameters. ?prerelease=false is ignored — identical 10 entries.
  • Capped at 10 entries.
  • Prereleases mixed in: 7 of the 10 newest entries were 1.1.0-next.*; only
    1.0.121.0.14 were stable.

getReleases() (apps/docs/src/lib/releases/githubReleases.ts) filters
prereleases out and groups patches under their minor. The feed does neither, and
at the current cadence a stable version scrolls out within a day.

Accepted deliberately: linking the raw feed costs almost nothing and beats
having no subscribe option. The link text must say the feed includes
prereleases, so nobody is surprised.

Outlook — not in scope

If the noise turns out to matter, the answer is our own feed: a route handler at
/releases.atom fed by getReleases(), making the feed content exactly the
curated timeline. That would also allow filtering by release kind
(?kind=major, or a major-only feed), which GitHub's feed can never do.
Separate issue when we get there.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in apps/docs/src/app/releases/page.tsx, reading the page's existing metadata and the intro Section. Add the German visible link to the GitHub Atom feed and configure metadata.alternates.types["application/atom+xml"] for autodiscovery; done means the link is visible and the generated page exposes the alternate feed link.

Written by the indexing model from the issue text.

Assessment

Tech stack
next.js, typescript
Domain
documentation, release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.