Skip to content

SEO round 2: TOC, watch CTA, star-history, support docs - #146

Merged
keysersoft merged 1 commit into
mainfrom
keysersoft/seo-round-2
May 10, 2026
Merged

keysersoft merged 1 commit into
mainfrom
keysersoft/seo-round-2

Conversation

@keysersoft

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #141. Tackles the next SEO/discoverability issues identified in the audit:

README

  • Collapsible Table of Contents at the top of the file
  • Demo GIF moved immediately under the banner (was buried mid-page)
  • star-history.com chart at the end, with light/dark variants
  • Two extra Star/Watch CTAs: one mid-document near the adapter catalog ("Don't see your favourite SaaS?"), one after the star-history chart
  • Top CTA line now mentions Watch + Fork, not just Star, so the watcher count starts moving from zero

Meta files

  • CHANGELOG.md — thin pointer to the Releases page (some scanners expect this file)
  • SUPPORT.md — surfaces the "Get help" sidebar with proper routing across Discussions, docs, security, commercial
  • .gitattributes — normalise line endings; tell Linguist that /docs, /content, MDX, and lockfiles are documentation/generated, so the language bar reflects actual product code (currently TypeScript 89.2 / MDX 7.7 / Shell 2.2 → expected TypeScript ~95 / Shell ~5)
  • .github/ISSUE_TEMPLATE/config.yml — disables blank issues, routes non-bug questions to Discussions, security to SECURITY.md
  • .github/CODEOWNERS — review routing for adapter catalog, frontend, infra, docs

Out of scope (separate work)

  • Pinned discussions, pinned issues, repo description update, release-note backfill — applied directly via API after merge.
  • Dual-license / GitHub Sponsors enrolment / dedicated OG image — require external decisions.

Test plan

  • README renders on github.com (TOC <details> works, star-history img loads)
  • .gitattributes syntax validated locally
  • After merge: language bar collapses MDX into "documentation"
  • After merge: "Get help" entry appears in repo's About sidebar (from SUPPORT.md)
  • After merge: New issue button no longer shows "Open a blank issue" — only the two YAML templates + 4 contact links

- README: add a collapsible Table of Contents at the top, surface the
  demo GIF immediately under the banner instead of buried mid-page,
  add a star-history.com chart at the bottom, sprinkle two extra
  Star/Watch CTAs (one mid-document near the adapter catalog, one
  after the chart). Add a "Watch this repo" hint to the top CTA line
  so the watch count starts moving from zero.
- Add CHANGELOG.md as a thin pointer to GitHub Releases.
- Add SUPPORT.md so the "Get help" sidebar surfaces with proper
  routing across Discussions, docs, security, and commercial channels.
- Add .gitattributes: normalise line endings and tell Linguist that
  /docs, /content, MDX and lockfiles are documentation/generated, so
  the language bar reflects actual product code.
- Add .github/ISSUE_TEMPLATE/config.yml: disable blank issues, route
  non-bug questions to Discussions, security to SECURITY.md.
- Add .github/CODEOWNERS for review routing.
@keysersoft
keysersoft enabled auto-merge (squash) May 10, 2026 11:02
@keysersoft
keysersoft merged commit bb65325 into main May 10, 2026
10 checks passed
@keysersoft
keysersoft deleted the keysersoft/seo-round-2 branch May 10, 2026 11:04
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