Skip to content

[Enhancement]: Docs - README's first screen is an 8-line run-on paragraph plus 11 badges; the hero GIF sits below the fold #1677

Description

@laurentiu021

Problem

Everything a newcomer sees before scrolling is text. README.md:3-10 is a single unbroken sentence that crams roughly twenty features into eight lines ("...live network diagnostics with gamer-friendly presets, Windows updates, disk and memory health, gaming launcher cache cleanup, app updates and bulk install via winget, performance tuning, privacy and telemetry controls, context menu management, secure file shredding, DNS & hosts editor, duplicate finder, battery health, process management..."). README.md:12-22 then stacks 11 badges (CI, CodeQL, codecov, Release, Downloads, Issues, Platform, .NET, winget, License, Stars). Only after that come the winget one-liner and the star plea. The first visual - docs/gifs/feature-tour.gif - is at README.md:61, and the comparison table at README.md:71. On a typical 1080p GitHub viewport the reader never reaches either without scrolling, so a graphical Windows app leads with a wall of prose and CI plumbing instead of a picture of itself.

Proposed solution

Restructure lines 1-36 into a hero block: (1) H1 plus one short tagline sentence; (2) move the feature-tour.gif <p align="center"> block from line 61 up to immediately under the tagline; (3) cut the badge row to the 5 a user cares about - Release, Downloads, Platform, .NET, License - and relocate CI / CodeQL / codecov / Issues to a small "Project health" line just above the Contributing section (or into CONTRIBUTING.md, where a contributor actually looks); (4) keep the winget install block and the star ask; (5) demote the current 8-line paragraph into the existing "What it is" section at README.md:38, split into 3 short sentences. Keep the comparison table right after the hero - it is the strongest differentiator and deserves above-or-near-fold placement.

Rationale

The GIF already exists and is good; it is simply buried under content that serves maintainers rather than visitors. For the aunt persona and for a Reddit/HN drive-by alike, one moving picture of the app answers "what is this" faster than any sentence. Badge soup also reads as noise and dilutes the two badges that build trust (Release freshness, total Downloads).

Evidence

README.md:3-10 - one sentence across 8 lines, verified by reading the file. sed -n '12,22p' README.md | grep -c '^\[\?!\[' -> 11 badge lines. First <img>/![ occurrence after the badges is docs/gifs/feature-tour.gif at README.md:61; comparison table starts README.md:71. grep -n -i 'table of contents' README.md -> no matches (see the separate TOC finding).

Risk / trade-off

Pure editorial churn on the project's most-read file, and "which badges matter" is a taste call the maintainer may want to own. Behaviour and links are unaffected; nothing outside README.md changes.

Affected area

Docs


Effort: M | priority: value 3/5, fit 4/5
Identified during the trust, distribution and reach audit audit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestuxVisual or interaction improvement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions