Skip to content

docs: add Vocs documentation site with GitHub Pages deployment - #58

Merged
peetzweg merged 1 commit into
masterfrom
feature-vocs
Apr 6, 2026
Merged

docs: add Vocs documentation site with GitHub Pages deployment#58
peetzweg merged 1 commit into
masterfrom
feature-vocs

Conversation

@peetzweg

@peetzweg peetzweg commented Apr 6, 2026

Copy link
Copy Markdown
Owner

Summary

  • Set up a Vocs documentation site with individual pages for each layout (month, big, classic, column, oneyear), CLI reference, batch mode guide, and installation instructions
  • Added GitHub Actions workflow (deploy-docs.yml) for automatic deployment to GitHub Pages on push to master
  • Added CI check that diffs --help output against a committed snapshot to detect docs/CLI drift
  • Slimmed down README to link to the full docs site while keeping quick-start and installation sections
  • Updated CHANGELOG with docs additions

Setup required after merge

Go to Settings > Pages and set Source to GitHub Actions to enable deployment.

Docs will be available at https://peetzweg.github.io/papr/.

Test plan

  • npm run docs:build succeeds, all 11 pages rendered
  • All pre-commit checks pass (fmt, clippy, 33 tests)
  • After merge: verify GitHub Pages deployment and all page links work
  • After merge: enable Pages source as "GitHub Actions" in repo settings

🤖 Generated with Claude Code

Set up a comprehensive documentation site using Vocs with individual pages
for each layout, CLI reference, batch mode guide, and installation instructions.
Includes a GitHub Actions workflow for automatic deployment to GitHub Pages and
a CI check that detects CLI help drift to keep docs, README, and --help in sync.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@codecov

codecov Bot commented Apr 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 29.48%. Comparing base (7887239) to head (1ec9a79).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #58   +/-   ##
=======================================
  Coverage   29.48%   29.48%           
=======================================
  Files          12       12           
  Lines        1550     1550           
=======================================
  Hits          457      457           
  Misses       1093     1093           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@peetzweg
peetzweg merged commit 311f696 into master Apr 6, 2026
4 checks passed
@github-actions github-actions Bot mentioned this pull request Apr 6, 2026
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