docs(readme): bring README in line with the readme documentation rule #432

Activity

1. credfeto

   added

   AI-WorkWork for an AI AgentWork for an AI Agent

   LowLow PriorityLow Priority

   on Oct 15, 2026
2. credfeto commented on Oct 15, 2026

   

   credfeto

   on Oct 15, 2026

   MemberAuthor

   More actions

   Priority set by the repository owner in live chat:

   q17 low

   Low label applied.
3. dnyw4l3n13

   self-assigned this

   on Oct 19, 2026
4. dnyw4l3n13 commented on Oct 19, 2026

   

   dnyw4l3n13

   on Oct 19, 2026

   Collaborator

   More actions

   Implementation Plan

   Files to change

   • README.md - restructure to the required section order, convert the badge to reference-style links, update the tagline.
   • CONTRIBUTING.md (new) and SECURITY.md (new) - only if the plan below is approved with them; the README sections P9/P10 need targets to link to (neither file exists in this repo).

   Approach

   Rewrite README.md in the order the readme documentation rule specifies. Applicable sections: title and an accurate one-line tagline (e.g. "FunFair's build notification service: receives GitHub, Watchtower and CloudFormation webhooks and posts the results to Discord", since BuildBot now posts through a webhook, #423); badges (the existing Build Status table, with a release row for build-and-publish-release.yml); Overview (2-3 sentences); Quick Start (run locally with dotnet run plus the two required settings); Installation (build/run via the Dockerfile image; no NuGet package, so no NuGet section); Usage (configuring the GitHub webhook and example endpoints); Documentation; Changelog (link to CHANGELOG.md); Contributing; Security; Licence (link to LICENSE). The existing Configuration and Deployment content is preserved and kept accurate, placed after Usage. All badge and URL links become reference-style with descriptive labels, collected at the bottom of the file and sorted alphabetically. The Contributors section is omitted unless the repository has more than one known human contributor (to be confirmed at implementation time). Sections with no target (Documentation without a docs/ folder, Contributing and Security without their files) are either backed by a minimal new file or omitted, per the rule "omit any section that does not apply".

   Test strategy

   Documentation-only change, no code tests. Verify with markdownlint against the repo's .markdownlint.json/pre-commit hooks, check every link and reference label resolves, confirm section order against the rule, and confirm all commands in Quick Start/Installation match the repo (Dockerfile, src project, env var names in the Configuration table).

   Assumptions

   • The Configuration and Deployment sections stay as they are (content is accurate after refactor(discord): replace Discord.Net bot login with a Discord webhook #428), just moved into the required order.
   • No docs/ folder exists, so the Documentation section is omitted rather than invented.
   • Contributing/Security sections are only included if the files exist.

   Open questions

   • Should I add minimal CONTRIBUTING.md and SECURITY.md files so those README sections can exist, or omit those sections? Default if not answered: omit the sections and add no new files.
   • Is the proposed tagline wording acceptable?
5. dnyw4l3n13

   added

   BlockedBlocked by a dependency or external factorBlocked by a dependency or external factor

   on Oct 19, 2026