Repository navigation
Docs: shorten service descriptions - #394
Draft
jackspiering wants to merge 2 commits into
Draft
jackspiering wants to merge 2 commits into
jackspiering wants to merge 2 commits into
Conversation
Shorten each service introduction to one or two sentences and match the root table. Correct descriptions that no longer match upstream.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Related Issues
Verification
docker compose config --quietfrom each changed service directory, with dummy values for required variablesrumdl check --config .markdownlint.yml .on the whole repository, andgit diff --checkCompose 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.
rumdl0.2.78, the versionlinting.ymlpins, reports no issues.git diff --checkis clean.Impact on existing users
Checklist
Additional Context