Skip to content

docs: refresh landing badges (Pro/donate, working CI badge, alt text) and add social meta - #221

Open
TimeToBuildBob wants to merge 1 commit into
ActivityWatch:masterfrom
TimeToBuildBob:docs/badges-and-social-meta
Open

TimeToBuildBob wants to merge 1 commit into
ActivityWatch:masterfrom
TimeToBuildBob:docs/badges-and-social-meta

Conversation

@TimeToBuildBob

Copy link
Copy Markdown
Contributor

The docs landing page still advertised the old "budget $201/mo from 40 supporters" badge, showed a "Test - no status" CI badge, had no alt text on its badges and no social/meta description.

  • src/badges.rst now mirrors the main README badge set: the stale budget badge is replaced by Pro (go/?src=docs) and Donate one-off badges.
  • The build badge points at release.yml (renders "Release - passing") instead of test.yml.
  • All 11 index <img> tags have alt, and the docs link uses https.
  • sphinxext-opengraph 0.13.0 is added, with a hand-written :og:description: and .. meta:: :description: on index.rst, because the auto description was the table of contents. The built index.html carries the meta description plus og:title/type/url/site_name/description/image.

Local sphinx-build succeeds. The warnings that remain were already there (duplicate autosection labels, media submodule not checked out). All 10 badge URLs return 200.

- Replace the stale "budget $201/mo from 40 supporters" badge with the
  README's Support ActivityWatch Pro and Donate one-off badges
- Point the build badge at release.yml (test.yml renders "no status")
- Add alt text to every badge and use https for the docs link
- Add sphinxext-opengraph so pages get og:* and <meta name=description>
  tags; give the index page a hand-written description

Git-Session-Id: 3be6034a-bbf1-4284-84b6-b543c09d9004
@TimeToBuildBob

Copy link
Copy Markdown
Contributor Author

Review guide (auto-posted)

Structured warm-up for reviewers — what changed, what to run, where to look.

Key files

  • poetry.lock (+21/-2, Δ23)
  • src/badges.rst (+13/-10, Δ23)
  • src/conf.py (+8/-0, Δ8)
  • src/index.rst (+5/-0, Δ5)
  • pyproject.toml (+1/-0, Δ1)

Suggested verification

  • make typecheck

Known risks / watch points

  • No automatic high-risk tags; use file list + diff for judgment.

Suggested review focus

  • Confirm behavior matches the PR description acceptance criteria.
  • Skim the largest diffs first (listed above).
  • If CI is green, spot-check the highest-risk paths called out here.

Generated by scripts/github/pr-warmup-review-guide.py for #221.

@greptile-apps

greptile-apps Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable issues were found.

Summary

Refreshes the landing badges and adds descriptions for search results and shared links.

  • The landing page shows updated support badges and clearer badge labels.
  • The landing page supplies a description and details for social previews.

No actionable issues found. Review was source-only; the build, live links, and rendered page were not rechecked.

Reviews (1) · Last reviewed commit: "docs: refresh landing badges and add Ope..." · Reviewed by Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant