Conversation
2f5ef5c to
9b6ce80
Compare
There was a problem hiding this comment.
Pull request overview
This pull request represents a complete migration of the documentation site from Jekyll (Ruby-based static site generator) to VitePress (Vue/Node-based static site generator). The changes include replacing all Jekyll configuration and templates with VitePress equivalents, updating the build pipeline from Ruby/bundler to Node/pnpm, and modernizing the documentation content format.
Changes:
- Replace Jekyll build system with VitePress (package.json, docs/.vitepress/config.mts)
- Migrate documentation content from Jekyll posts to VitePress-compatible markdown files in the docs directory
- Update GitHub Actions workflow to deploy to S3 instead of GitHub Pages
- Remove Ruby/Jekyll dependencies (Gemfile, Gemfile.lock) and old Jekyll layouts/includes
- Add VitePress theme customization with snapAddy branding
Reviewed changes
Copilot reviewed 45 out of 54 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Adds VitePress and Vue dependencies with pnpm package manager configuration |
| docs/.vitepress/config.mts | VitePress configuration with site navigation, theming, and build settings |
| docs/.vitepress/theme/index.js | VitePress theme entry point importing default theme and custom styles |
| docs/.vitepress/theme/style.css | Custom CSS with snapAddy brand colors and responsive design |
| docs/index.md | VitePress home page layout replacing old Jekyll theme |
| docs/*.md | Documentation pages migrated from Jekyll _posts format to VitePress markdown |
| .gitignore | Updated for Node.js/VitePress build artifacts instead of Jekyll/Bundler |
| .github/workflows/deploy.yaml | New deployment workflow for S3 instead of GitHub Pages |
<store_comment>
<comment_type>best_practices</comment_type>
<file_location>docs/.vitepress/config.mts</file_location>
<start_line>33</start_line>
<end_line>33</end_line>
<comment_content>The sidebar contains a test entry { text: 'TEST', link: '/test' } that appears to be debug content and should be removed before deployment to production</comment_content>
moderate
false
</store_comment>
<store_comment>
<comment_type>discrepancy_with_pr_description</comment_type>
<file_location>CNAME</file_location>
<start_line>1</start_line>
<end_line>1</end_line>
<comment_content>The CNAME file has been deleted entirely. If this documentation site uses a custom domain (mapping.snapaddy.com as indicated in the old file), you must ensure the custom domain is configured in the GitHub repository settings under Pages, otherwise the site will be inaccessible at that domain. Note: The new deployment workflow deploys to S3, so CNAME configuration may need to be handled there instead</comment_content>
moderate
false
</store_comment>
<store_comment>
<comment_type>documentation</comment_type>
<file_location>docs/.vitepress/config.mts</file_location>
<start_line>70</start_line>
<end_line>72</end_line>
<comment_content>The markdown syntax highlighting theme is configured to use 'github-light-default' and 'solarized-dark', but these theme names appear to be non-standard for Shiki (the syntax highlighter used by VitePress). Standard Shiki themes include names like 'github-light', 'github-dark', etc. Verify these theme names are correct and available in the Shiki version being used</comment_content>
moderate
false
</store_comment>
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Simon Berz <simon@berz.me>
Signed-off-by: Simon Berz <simon@berz.me>
No description provided.