Add README with dev setup, build, and deployment docs - #12
Open
miharp wants to merge 1 commit into
Open
Conversation
Covers the Jekyll + Vite architecture, local development workflow, the Vite-before-Jekyll build order, adding product pages, and both deployment paths (GitHub Pages and the ghcr.io Docker image). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
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
1 participant
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.
The repo had no README. This adds one covering:
npm run devworkflow, plus a Docker-only option for contributors without Node/Ruby installed_data/manifest.jsonexists)_products/deploy.ymland the ghcr.io Docker image viadocker-publish.yml_config.ymlalready excludesREADME.md, so nothing leaks into the published site.Written with AI assistance (Claude Code); reviewed and verified by me.