Polish README into a proper FOSS project page #140

New issue

Closed

opened 2026-08-13 20:54:07 +02:00 by myrmidex · 0 comments

myrmidex commented

2026-08-13 20:54:07 +02:00

Owner

The README currently reads as personal-project notes. Bring it up to the
standard a visitor expects from a public FOSS repo.

Scope was widened beyond the README itself to a full repo-presentation pass —
a visitor judges the repo root, not just one file.

README

Header: project name, one-line description, badges (CI status, license, latest release)
Short "what it does" paragraph — Fediverse feed routing in plain language
Screenshots of the dashboard (space left bare; images supplied separately)
Features list
Requirements + install (Docker compose as the primary path)
Configuration: the environment variables that actually matter
Usage: adding a feed, adding a channel, how routing works
Contributing + issue-reporting pointer
License section

Supporting files

LICENSE — AGPL-3.0, copyright holder lvl0. No LICENSE file currently
exists even though the README already links to one.
CHANGELOG.md — from v1.4.0 onward only, not backfilled.
CONTRIBUTING.md — as its own file (supersedes the earlier
"out of scope" note below).

Repo cleanup

Verified dead, zero references outside their own definitions:

Jenkinsfile — invokes a run-regression-tests.sh that does not exist,
and competes with .forgejo/workflows/ci.yml
app/Http/Middleware/HandleInertiaRequests.php — not registered in
bootstrap/app.php
composer deps inertiajs/inertia-laravel, tightenco/ziggy,
laravel/breeze — no references in app/config/routes/resources/bootstrap,
no tracked .jsx/.tsx, no React entrypoint in vite.config.js

composer.json metadata

Still stock starter-kit values: name laravel/react-starter-kit, description
"The skeleton application for the Laravel framework", and license: MIT,
which contradicts the README's AGPL-3.0 claim. Fix all of it.

AI assistance note

Add a small, matter-of-fact remark (one or two lines, near the bottom) that
this project was developed with AI assistance. No disclaimer tone, no banner.

Out of scope

Wiki content

The README currently reads as personal-project notes. Bring it up to the standard a visitor expects from a public FOSS repo. Scope was widened beyond the README itself to a full repo-presentation pass — a visitor judges the repo root, not just one file. ### README - Header: project name, one-line description, badges (CI status, license, latest release) - Short "what it does" paragraph — Fediverse feed routing in plain language - Screenshots of the dashboard (space left bare; images supplied separately) - Features list - Requirements + install (Docker compose as the primary path) - Configuration: the environment variables that actually matter - Usage: adding a feed, adding a channel, how routing works - Contributing + issue-reporting pointer - License section ### Supporting files - `LICENSE` — AGPL-3.0, copyright holder lvl0. No LICENSE file currently exists even though the README already links to one. - `CHANGELOG.md` — from v1.4.0 onward only, not backfilled. - `CONTRIBUTING.md` — as its own file (supersedes the earlier "out of scope" note below). ### Repo cleanup Verified dead, zero references outside their own definitions: - `Jenkinsfile` — invokes a `run-regression-tests.sh` that does not exist, and competes with `.forgejo/workflows/ci.yml` - `app/Http/Middleware/HandleInertiaRequests.php` — not registered in `bootstrap/app.php` - composer deps `inertiajs/inertia-laravel`, `tightenco/ziggy`, `laravel/breeze` — no references in app/config/routes/resources/bootstrap, no tracked `.jsx`/`.tsx`, no React entrypoint in `vite.config.js` ### composer.json metadata Still stock starter-kit values: name `laravel/react-starter-kit`, description "The skeleton application for the Laravel framework", and `license: MIT`, which contradicts the README's AGPL-3.0 claim. Fix all of it. ### AI assistance note Add a small, matter-of-fact remark (one or two lines, near the bottom) that this project was developed with AI assistance. No disclaimer tone, no banner. ### Out of scope - Wiki content