Skip to content

Docs: rework the README and fix the service tables - #373

Open
jackspiering wants to merge 2 commits into
mainfrom
readme-rework
Open

jackspiering wants to merge 2 commits into
mainfrom
readme-rework

Conversation

@jackspiering

Copy link
Copy Markdown
Collaborator

Description

Reworks the root README.

  • Quick Start: adds the MagicDNS/HTTPS prerequisite, the Compose version, auth key options (ephemeral, pre-approved, reusable, expiry), a "read the service README" step, and how to open the service. The heading stays, because 41 service READMEs link to it.
  • New "Update a stack", "Remove a stack" and "Get help" sections, a single "Tailscale Serve and Funnel" section, and a reworked "Documentation" section.
  • Tables:
    • Names fixed (14, such as FlareSolverr, NetBox, MeTube).
    • 56 descriptions rewritten to match each service README and upstream, including the wrong ones for Recyclarr, Slink, Karakeep and Nessus.
    • File Browser and Hemmelig marked **PROJECT ARCHIVED**.
    • Paperless-ngx, Frigate, Homarr and changedetection.io moved to the fitting category.
    • Every table sorted alphabetically.
  • Nessus README updated to the current Essentials terms, and File Browser README notes the archived upstream.
  • Nits: star history back on api.star-history.com, ```sh fences, trailing whitespace, leftover contributors markers, license link, diagram alt text, 🍽️ in the Food & Wellness header.

Related Issues

  • None.

Verification

  • rumdl check --config .markdownlint.yml . (0.2.77 and 0.2.78) and git diff --check origin/main are clean.
  • All 123 service directories are linked exactly once, and all TOC anchors resolve by a local slug check (not rendered on github.com).
  • New external links return 200. GitHub's API reports File Browser and Hemmelig as archived. The Tailscale facts (MagicDNS/HTTPS, key options, Funnel ports, Compose 2.23.1 for inline configs) were checked against their docs.
  • Not included, because they could not be confirmed: the File Browser archive date, the "since Nessus 10.11.0" version, and the File Browser known-issues list.

Checklist

  • I have performed a self-review of my code and followed the templates structure.
  • I have added verification that the stack works as expected.
  • I have updated necessary documentation (e.g. frontpage README.md ).
  • I have selected the correct label(s) for this PR.

Additional Context

From an external review of the repository (section 2). Judgement-call category moves (File Browser, Gokapi, SearXNG, Forgejo, Gitea, Vaultwarden) and the Picard image note are left for a later change. The OpenPLi guide is retitled in the guides PR.

The new Quick Start, Machines and DNS links pointed to login.tailscale.com. The template and the service READMEs use console.tailscale.com, as Tailscale's docs do.
@jackspiering
jackspiering requested a review from crypt0rr October 10, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant