Skip to content

Docs: shorten service descriptions - #394

Draft
jackspiering wants to merge 2 commits into
mainfrom
t3code/shorten-service-readmes
Draft

jackspiering wants to merge 2 commits into
mainfrom
t3code/shorten-service-readmes

Conversation

@jackspiering

@jackspiering jackspiering commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Shortens the description of every service and checks it against the upstream site or repository. Only those sentences change. Setup steps, ports, headings, and Compose files are untouched.

Each service README introduction is one or two sentences. A second sentence stays only when it changes what you get: an archived project, a licence limit, or what this stack runs. Feature lists are left to upstream.

The root table uses the same facts in a shorter phrase. Corrections, not just cuts:

  • AFFiNE is described as a workspace only. The Notion and Miro comparison is left to upstream.
  • ArtistTrackarr watches Spotify and uses MusicBrainz for artist identity. It also covers singles and compilations.
  • BookLore is in maintenance mode. Active development has moved to BookOrbit.
  • ConvertX converts files on the server. It does not run in the browser.
  • Dockhand is free for home and non-commercial use. Production use by a business or public body needs a commercial licence.
  • Isley is a cannabis grow journal.
  • Joplin Server is licensed for personal, non-commercial use only.
  • Stirling-PDF's free plan covers five users. This stack runs the server, not a browser-only toolkit.
  • Vaultwarden is an unofficial Bitwarden-compatible server.
  • Nessus Essentials does not include compliance checks, and it does not keep scan data after the 30-day licence expires.
  • Pi-hole is a DNS sinkhole. Technitium is an authoritative and recursive DNS server.
  • Coder also provisions AI coding agents. FlareSolverr also solves DDoS-GUARD challenges.
  • FreshRSS in this stack uses SQLite. Forgejo is described as a community-governed fork of Gitea, which is how it differs from Gitea.
  • A Hytale game licence is required. Mailpit in this stack does not relay captured mail.

Related Issues

  • None.

Verification

  • docker compose config --quiet from each changed service directory, with dummy values for required variables
  • The stack started, Tailscale is healthy, and the service is reachable through the Tailnet
  • The main function of the service works, and its data survives a restart
  • rumdl check --config .markdownlint.yml . on the whole repository, and git diff --check

Compose validation was not run because no Compose file changed. The stack checks are not run: this change is description text only, and starting every stack would register a new Tailscale device per service.

rumdl 0.2.78, the version linting.yml pins, reports no issues. git diff --check is clean.

Impact on existing users

  • None.

Checklist

  • I have performed a self-review of my code and followed the templates structure.
  • I did not commit a working auth key, password, token, or other credential.
  • The service README uses the headings of the template, in the same order, and is up to date.
  • I added, removed, or renamed the service in the root README.md, in alphabetical order, or this PR does not change the list of services.

Additional Context

  • Eleven service introductions were already short and accurate and were left as they are: AdGuard Home, Caddy, Dozzle, Eigenfocus, Excalidraw, LanguageTool, Plex, Portracker, Prowlarr, qBittorrent, and Resilio Sync. Caddy and LanguageTool keep a second sentence about what the stack runs.
  • Service introductions use British spelling, as they already did. The root table stays in American spelling, as it already did.

Shorten each service introduction to one or two sentences and match the root table. Correct descriptions that no longer match upstream.
@jackspiering jackspiering added the documentation Improvements or additions to documentation label Oct 13, 2026
@jackspiering jackspiering self-assigned this Oct 13, 2026
Drop the AFFiNE licence sentence, which misread the Community Edition licence. Restore Subsonic-compatible for Navidrome, narrow the Dockhand licence note, and drop "no public uploads" for Gokapi, which now has file requests. Fix the FossFLOW, Picard, Hemmelig, and Beszel agent wording, restore the Bazarr order, and shorten Homebox.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant