docs: add Gemara documentation site #191
Draft
+1,469
−1
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.
Description
This PR introduces the foundational documentation infrastructure for Gemara with a Jekyll-based site and automated GitHub Pages deployment. This establishes the framework for comprehensive documentation including automated CUE schema generation (to be completed in follow-up commits).
Implementation Status: 4 of 7 tasks completed
Changes
1. Jekyll Documentation Site (
docs/)2. Automated Schema Documentation Generator (
utils/cuedocs/main.go) - IN Progress3. GitHub Actions Workflows
Jekyll Site Workflow (
.github/workflows/jekyll-site.yml):4. Dependabot Configuration
Adds
bundlerecosystem to.github/dependabot.yamlto ensure Jekyll Gems stay up-to-date with security patches and updates.5. Makefile Enhancements
New targets for documentation workflow:
Testing
Local Testing
make serve # Visit http://localhost:4000 make stopVerified:
CI Testing
Related Issues
Partially resolves issue #155
Checklist
git commit -s)Additional Notes
For Reviewers:
docs/directory (Jekyll site structure)make serveNext Steps:
utils/cuedocs/)Design Decisions: