Skip to content

Set repo homepage field and enable GitHub Pages from docs/ #27

Description

@zzallirog

What this is

The repository homepage field is currently null. Every aggregator
(Trendshift, awesome-lists, GitHub trending, npm-style scrapers) reads this
field — its absence signals "abandoned side project" to automated tooling.
GitHub renders a "Website" link in the sidebar only when homepage is set.
The existing docs/ directory contains 25+ markdown files that can be served
as static pages immediately with no new content required.

Architectural answer (pre-set)

Step 1 — Set homepage field:

gh repo edit --homepage "https://zzallirog.github.io/weighted-compact"

Step 2 — Enable GitHub Pages:
Repo Settings → Pages → Source: Deploy from branch → Branch: main
Folder: /docs. GitHub will serve docs/README.md (to be created per
issue #14) as the index page.

Step 3 — Verify:

gh repo view --json homepageUrl

Wait for the Pages deployment to complete (~2 min), then visit the URL.

No new content is required for the minimum viable version. The existing
docs/01-substrate.md through docs/operating-guide.md become indexed
static pages immediately.

The real payoff: docs/importance-mixture.md and the methodology table
land on a dedicated citable URL. This enables "cited in X" and
"mentioned in awesome-claude-code" submission paths.

Open question for the contributor

Maintainer-owned; no open question. The only decision is whether to use
GitHub Pages default styling or add a minimal _config.yml (Jekyll) for
a title. Recommended: add _config.yml with title: weighted-compact and
theme: minima only — no custom CSS required.

Where to start

# Set the field
gh repo edit --homepage "https://zzallirog.github.io/weighted-compact"
# Enable Pages via GitHub web UI (Settings → Pages)
# Optional: add docs/_config.yml with two lines
echo "title: weighted-compact\ntheme: minima" > docs/_config.yml

What NOT to do

  • Do not set up a custom domain or external hosting — GitHub Pages is
    sufficient and adds no maintenance burden.
  • Do not add MkDocs, ReadTheDocs, or any external doc site — out of scope
    per project invariants.
  • Do not create new documentation content for this issue — serve what exists.

Skill level

S — two UI clicks + one gh command. Maintainer-owned (requires repo admin).

5× rationale

homepage set → GitHub sidebar link → external indexing → aggregator
pick-up → "mentioned in X" badge opportunity. The compounding path:
Pages URL → dedicated methodology URL → HN post citable link →
awesome-claude-code submission → badge in README → trust signal for the
next reader. Each step is gated on the field being non-null.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentation / translationmaintainer-ownedBest done by maintainer (deep context / one-off narrative / small surgical)priority:5xx5 better, not parity — high-leverage compounding actionssize:SSmall — under a day

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions