Skip to content

docs: add docs/index.html for GitHub Pages mirror (5-surface stack)#69

Merged
Wolfe-Jam merged 1 commit into
mainfrom
docs/gh-pages-mirror
May 23, 2026
Merged

docs: add docs/index.html for GitHub Pages mirror (5-surface stack)#69
Wolfe-Jam merged 1 commit into
mainfrom
docs/gh-pages-mirror

Conversation

@Wolfe-Jam
Copy link
Copy Markdown
Owner

Why

faf-cli is the biggest FAF package by downloads — ~28,000 combined (faf-cli 27,704 + faf 983, measured). 4 surfaces today (npm ×2 + Homebrew + GH Releases + Vercel); largest gap missing GitHub Pages.

Closes that gap with the cheapest 5th surface (static docs/index.html + Pages source flip). Same template as grok-faf-mcp / faf-mcp / claude-faf-mcp, CLI-shaped:

  • Three Ways to Install: npm / Homebrew / npx
  • AI Interop section: project.faf → AGENTS.md · .cursorrules · CLAUDE.md · GEMINI.md
  • Stats verified live: 25,000+ downloads (rounded DOWN from 27,704+983), v6.7.1 = npm latest, 100% Trophy
  • No unsourced perf claims · "HTML Edition" matches README

After merge

gh api -X POST 'repos/Wolfe-Jam/faf-cli/pages' -f 'source[branch]=main' -f 'source[path]=/docs'

https://wolfe-jam.github.io/faf-cli/NO CNAME (github.io plain, per corrected 5-surface doctrine). Existing docs/*.md unaffected; index.html becomes Pages root.

Brings faf-cli into the 5-surface MCP-family distribution pattern that
grok-faf-mcp, faf-mcp, and claude-faf-mcp already use. faf-cli is the
biggest package by downloads (~28k combined across faf-cli + faf
dual-publish) and was the last large gap missing a Pages mirror.

CLI-shaped adaptation of the claude-faf-mcp template:
- Three Ways to Install: npm / Homebrew / npx (in place of Claude Desktop config)
- 'AI Interop' section showcasing project.faf -> AGENTS.md / .cursorrules
  / CLAUDE.md / GEMINI.md (the killer faf-cli feature)
- Stats verified live: 25,000+ downloads (rounded down from 27,704 +
  983 measured), v6.7.1 matches npm latest, 100% Trophy

No unsourced performance claims (per FAF-don't-lie discipline).
Existing docs/*.md files unaffected — index.html serves as Pages root,
other docs render via default Jekyll alongside.

Pages source must be flipped to main/docs after merge:
  gh api -X POST 'repos/Wolfe-Jam/faf-cli/pages' -f 'source[branch]=main' -f 'source[path]=/docs'

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
faf-cli Ready Ready Preview, Comment May 23, 2026 4:05am

@Wolfe-Jam Wolfe-Jam merged commit 1bfa608 into main May 23, 2026
12 checks passed
@Wolfe-Jam Wolfe-Jam deleted the docs/gh-pages-mirror branch May 23, 2026 05:19
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