The docs site (added in #59) is deliberately local-only — npm run docs:dev. Publishing it and measuring usage were discussed and deferred; this issue captures the analysis so we don't redo it.
Publishing to GitHub Pages
tashtit/cockpit is public, so Pages is free. It is not currently enabled and no homepage is set.- The config needs
base: '/cockpit/' before deploying to a project-pages URL — the site is otherwise root-relative and links would break.
- Suggested shape: a separate
.github/workflows/docs.yml path-filtered to docs/**, using actions/deploy-pages, so docs pushes skip the test matrix and app pushes don't rebuild docs.
Analytics
GitHub Pages provides no usage stats of its own — repo Insights → Traffic only covers repo views/clones, 14 days back. So it needs a client-side script:
- Umami Cloud — free Hobby tier (100k events/month, 3 sites), cookieless so no consent banner, real-time dashboard, custom events and a full API. Preferred option.
- GoatCounter — free for open source, cookieless, deliberately minimal (pageviews, referrers, browsers). Good if we want the lightest possible thing.
- GA4 — queryable through the Google Analytics MCP already in use, but developer audiences block it heavily and it drags in consent-banner obligations.
Worth noting these measure docs traffic only; GitHub release download counts are the closer proxy for actual app usage and are cheap to track alongside.
No urgency — revisit once the docs content has settled.
The docs site (added in #59) is deliberately local-only —
npm run docs:dev. Publishing it and measuring usage were discussed and deferred; this issue captures the analysis so we don't redo it.Publishing to GitHub Pages
tashtit/cockpitis public, so Pages is free. It is not currently enabled and no homepage is set.base: '/cockpit/'before deploying to a project-pages URL — the site is otherwise root-relative and links would break..github/workflows/docs.ymlpath-filtered todocs/**, usingactions/deploy-pages, so docs pushes skip the test matrix and app pushes don't rebuild docs.Analytics
GitHub Pages provides no usage stats of its own — repo Insights → Traffic only covers repo views/clones, 14 days back. So it needs a client-side script:
Worth noting these measure docs traffic only; GitHub release download counts are the closer proxy for actual app usage and are cheap to track alongside.
No urgency — revisit once the docs content has settled.