Skip to content

[Enhancement]: Docs - No GitHub Pages landing page #1679

Description

@laurentiu021

Problem

There is no Pages site: gh api repos/laurentiu021/SystemManager/pages returns 404, there is no _config.yml at the root or in docs/, and no docs/index.*. homepageUrl is set to https://github.com/laurentiu021/SystemManager/releases/latest, so the repo's own "website" field points at a raw release listing. The consequence for reach: the only shareable URL for the project is either that release list or a 1095-line README with no TOC (see the TOC and first-screen findings), so a Reddit, Hacker News or forum post has nothing that reads as a product page - and search engines have no lightweight page to rank for queries like "open source windows cleanup tool". The raw material already exists and is unused outside the README: docs/gifs/feature-tour.gif, docs/gifs/cleanup-tools.gif, 44 screenshots, and the comparison table.

Proposed solution

Enable Pages with source = main branch, /docs folder (that folder already exists and is already the screenshot/GIF home, so the assets resolve with no duplication) and add a single docs/index.md with a Jekyll theme front-matter block plus docs/_config.yml. Content, in order: tagline, feature-tour.gif, a prominent "Download for Windows 10/11" button to /releases/latest, the winget install laurentiu021.SysManager one-liner, the comparison table, a 6-shot screenshot strip, and the SmartScreen first-launch note. Then repoint the repo's homepageUrl at the Pages URL so the sidebar link leads to a product page. Critical constraint: keep index.md short and link back to README for detail - it must never become a second feature list to maintain.

Rationale

Reach is the stated gate for the code-signing certificate, and external posts are the main reach lever. A one-page site is what makes a link postable: it loads fast, shows the app moving in the first screen, and gives one obvious download action - none of which the README's first screen currently does. It also gives an SEO landing target the repo does not have today.

Evidence

gh api repos/laurentiu021/SystemManager/pages -> {"message":"Not Found",...,"status":"404"}. ls _config.yml docs/_config.yml docs/index* -> all "No such file or directory". gh repo view --json homepageUrl -> https://github.com/laurentiu021/SystemManager/releases/latest. Assets confirmed present: docs/gifs/feature-tour.gif (350 KB), docs/gifs/cleanup-tools.gif (200 KB), 44 PNGs under docs/screenshots/. docs/ currently holds only gifs/, screenshots/ and manual-smoke.ps1, so it is free to serve as the Pages root. wc -l README.md -> 1095, with no TOC.

Risk / trade-off

This is the lowest-certainty item in this set: it creates a second marketing surface that will drift from README unless deliberately kept thin, and the payoff is speculative until there is actually an external post to link. Recommend it only after the hero/screenshot findings land - a landing page built on a stale screenshot set (incl. the Work-in-Progress Bandwidth Monitor shot) would amplify the wrong thing. Enabling Pages is also a repo-settings action, not a commit.

Affected area

Docs


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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions