docs: add Vocs documentation site with GitHub Pages deployment - #58
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
month,big,classic,column,oneyear), CLI reference, batch mode guide, and installation instructionsdeploy-docs.yml) for automatic deployment to GitHub Pages on push tomaster--helpoutput against a committed snapshot to detect docs/CLI driftSetup 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:buildsucceeds, all 11 pages rendered🤖 Generated with Claude Code