Skip to content

Docs: remove emojis and tighten the README - #380

Merged
crypt0rr merged 1 commit into
mainfrom
t3code/175cc373
Oct 13, 2026
Merged

crypt0rr merged 1 commit into
mainfrom
t3code/175cc373

Conversation

@jackspiering

Copy link
Copy Markdown
Collaborator

Description

Cleans up the root README.md so the application list is easier to scan.

  • Removes the emojis from the section headings, table headers, and service names.
  • Rewrites every description as one short noun phrase. It drops the repeated "A self-hosted…" and filler such as "lightweight" and "highly customizable", and removes claims that the service README does not support.
  • Marks archived projects the same way: "Archived." instead of "PROJECT ARCHIVED".
  • Renames "Food & wellness" to "Food and wellness". With no emoji, the headings now give plain anchors, so the two <a id> workarounds are gone.
  • Moves five misfiled services:
    • Vaultwarden to Networking and security.
    • Forgejo and Gitea to Development tools.
    • File Browser and Gokapi to Productivity and collaboration.
  • Moves the table of contents above "Featured by Tailscale", splits Quick Start step 6 into bullets, and shortens the intro, Featured, Contributors, and Contributing text.
  • Changes the H1 to "ScaleTail" and corrects "AdGuardHome Sync" to "AdGuard Home Sync".

Related Issues

  • None.

Verification

  • rumdl 0.2.78, the version linting.yml pins, reports no issues on the whole repository.
  • git diff --check origin/main is clean.
  • A search for emoji characters in README.md finds none.
  • All 123 directories in services/ are linked once, and every table is sorted by name, ignoring case.
  • I did not run Compose validation, because no stack changed.

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 ran Compose validation with dummy values for required variables.
  • I ran rumdl on the whole repository.
  • I committed no working credential.

Additional Context

  • Not applicable: no stack changed, so the stack verification and Compose boxes stay unchecked.
  • The Vaultwarden, Forgejo, Gitea, File Browser, and Gokapi moves are judgment calls. SearXNG and Tautulli could also move, but I left them.
  • Some service README titles differ from the bold names in the list, for example Picard ("MusicBrainz Picard"), Technitium DNS, Hytale, Minecraft, and the Tailscale App Connector and Subnet Router "Node" suffixes. I left them.
  • I kept a few claims from the old text that the repository does not confirm: ClipCascade's end-to-end encryption, Copyparty's resumable uploads, Wallos's multi-currency support, and Isley's "cannabis".

Remove the emojis from the application list and rewrite the descriptions as one-line noun phrases. Move five misfiled services to better categories, fix the table of contents anchors, and shorten the intro, Quick Start, and contributor text.
@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 11:43
@crypt0rr
crypt0rr merged commit 5141b2f into main Oct 13, 2026
2 checks passed
@crypt0rr
crypt0rr deleted the t3code/175cc373 branch October 13, 2026 11:44
@jackspiering jackspiering mentioned this pull request Oct 13, 2026
2 of 4 tasks
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