Skip to content

Docs: clarify service descriptions in the README - #381

Merged
crypt0rr merged 1 commit into
mainfrom
docs/clarify-service-descriptions
Oct 13, 2026
Merged

crypt0rr merged 1 commit into
mainfrom
docs/clarify-service-descriptions

Conversation

@jackspiering

Copy link
Copy Markdown
Collaborator

Description

Makes the service descriptions in the root README.md clearer. Three subagents compared every row with its service README, and I checked each proposed change against that README before editing. Only rows that were vague, jargon-heavy, easy to confuse with a similar service, or missing a caveat that the service README states up front changed. The other rows are untouched.

Service Old New Why
Vaultwarden Unofficial Bitwarden server written in Rust. Password manager server that works with the Bitwarden apps and browser extensions. The old text never said what it is.
Sure Personal finance app for accounts, investments, and net worth, with optional AI features. Fork of the archived Maybe finance app, for tracking accounts, investments, and net worth. People look for Maybe.
SubTrackr Web app for tracking subscriptions, renewal dates, and costs. Subscription tracker that shows monthly and yearly costs and when each one renews. Tells it apart from Wallos.
Wallos Tracker for recurring subscriptions and expenses, with multi-currency support. Subscription and expense tracker with payment reminders and budget help. Matches its service README.
AFFiNE Workspace for documents, whiteboards, and databases. Open-source alternative to Notion and Miro, for documents, whiteboards, and databases. Says what kind of tool it is.
Configarr Config sync that applies TRaSH Guides and YAML settings to Radarr, Sonarr, and related apps. Tool that applies YAML settings and TRaSH Guides profiles to Radarr and Sonarr, then exits. Tells it apart from Recyclarr. It runs once.
Recyclarr Sync tool for TRaSH Guides quality profiles and custom formats in Radarr and Sonarr. Tool that applies TRaSH Guides quality profiles from a YAML file to Radarr and Sonarr on a schedule. Tells it apart from Configarr. It runs on a schedule.
EspoCRM CRM for sales, support, and marketing. Customer relationship manager for contacts, companies, and sales opportunities. The acronym was not explained.
Forgejo Community-governed Git service with pull requests, issues, packages, and CI. Community-governed fork of Gitea with pull requests, issues, packages, and CI. Tells it apart from Gitea.
Gitea Git service with repositories, pull requests, issues, packages, and CI. Lightweight Git service with repositories, pull requests, issues, packages, and CI. Matches its service README.
Gotify Server to send and receive notifications in real time over HTTP. Push notification server that shows messages from your scripts in its web interface and Android app. Says who sends and who receives.
ntfy HTTP-based pub/sub service that sends push notifications to phones and browsers. Notification service that lets scripts and apps push messages to phones and browsers over HTTP. "Pub/sub" was jargon.
Hytale Hytale game server that players reach over your Tailnet. Hytale game server in a community image, for players on your Tailnet. The image is not official.
Homarr Dashboard for your services that shows live information from many apps. Dashboard with user accounts that shows live data from the apps you connect. Tells it apart from Homepage.
Homepage Dashboard for your services and bookmarks, with live data from apps and Docker. Dashboard that you set up in YAML files, with bookmarks and live data from apps and Docker. Tells it apart from Homarr.
Kaneo Project management tool with boards and tasks. Open-source project tracker with boards and tasks, an alternative to Trello and Linear. The old text fit any project tool.
LanguageTool Grammar, style, and spelling checker server for many languages. Grammar and spelling checker server for browser extensions, with no web interface. The stack has no web interface.
Miniflux Feed reader for RSS, Atom, and JSON feeds. Minimalist feed reader for RSS, Atom, and JSON feeds, with a PostgreSQL database. Tells it apart from FreshRSS.
NetBox Source of truth for IP addresses, racks, devices, connections, and circuits. Network documentation tool for IP addresses, racks, devices, connections, and circuits. "Source of truth" was jargon.
Ollama Local runtime for open large language models, with an OpenAI-compatible API. Runtime for large language models, with an OpenAI-compatible API and no login. The API has no authentication.
Pi-hole DNS sinkhole that blocks ads and trackers for your whole network. DNS server that blocks ads and trackers for every device that uses it. "Sinkhole" was jargon, and "whole network" overstated it.
Plex Media server for your video, music, and photo libraries. Media server that streams your movies, series, and music to Plex apps; needs a Plex account. The stack sets up movies and series, and it needs a Plex account.
RustDesk Server ID and relay server for RustDesk remote desktop clients. Your own ID and relay server for RustDesk clients, so they skip the public servers. Says why you would run it.
NextExplorer File explorer for browsing, uploading, and editing files in a mounted folder. Web file manager for browsing, uploading, and editing files in one folder on your server. Says it is a web app.
Tailscale App Connector Node App connector that routes traffic for selected apps through this device. App connector that sends Tailnet traffic for chosen domains through this host. The old text defined the term with itself.
Speedtest Tracker Scheduled internet speed tests, with results charted over time. Tool that runs scheduled internet speed tests and charts the results over time. Starts with a noun, like the other rows.
Frigate Network video recorder with real-time AI object detection for IP cameras. Network video recorder with real-time AI object detection for IP cameras, using an optional GPU or accelerator. Mentions the hardware option.

The tables are also re-padded so the pipes stay aligned. That changes whitespace on every row of the affected tables, so use "Hide whitespace" or git diff -w to review. It also fixes three rows that were already misaligned (AdGuard Home Sync, Configarr, and Prowlarr).

Related Issues

  • None.

Verification

  • rumdl check --config .markdownlint.yml . (rumdl 0.2.78, the version that .github/workflows/linting.yml pins): no issues in 131 files.
  • git diff --check origin/main: clean.
  • With git diff -w, only the rows above and their table separator lines differ.
  • Compose validation does not apply, because no stack changed. No live Tailnet test applies.

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. (Not applicable: no stack changed.)
  • I have updated necessary documentation (e.g. frontpage README.md ).
  • I ran Compose validation with dummy values for required variables. (Not applicable: no stack changed.)
  • I ran rumdl on the whole repository.
  • I committed no working credential.

Additional Context

  • Forgejo as "fork of Gitea" comes from the Forgejo project's own history, not from its service README.
  • Wallos lost "multi-currency support" because its service README does not state it.

@jackspiering jackspiering added the documentation Improvements or additions to documentation label Oct 13, 2026
@jackspiering jackspiering self-assigned this Oct 13, 2026
@jackspiering
jackspiering marked this pull request as ready for review October 13, 2026 12:40
@crypt0rr
crypt0rr merged commit 8467ca2 into main Oct 13, 2026
2 checks passed
@crypt0rr
crypt0rr deleted the docs/clarify-service-descriptions branch October 13, 2026 12:43
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.

2 participants