-
Notifications
You must be signed in to change notification settings - Fork 17
docs: add Gemara documentation site #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add Gemara documentation site #191
Conversation
Introduces foundational documentation infrastructure for Gemara: - Jekyll-based documentation site (docs/) - GitHub Actions workflow for automated deployment - Makefile targets for local development - Dependabot bundler configuration Partially resolves ossf#155 Signed-off-by: sonupreetam <[email protected]>
51faea7 to
2f94ee8
Compare
eddie-knight
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great!
jpower432
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! I'm running into issues get this to serve locally, but I think it might be isolated. I was able to with a couple changes to the container command. Just left a minor suggestion on the author in the config.
Co-authored-by: Jennifer Power <[email protected]> Co-authored-by: Eddie Knight <[email protected]> Signed-off-by: t_hat <[email protected]>
|
@jpower432 Thank you for your review. If required, I can update the Makefile to automatically detect the host architecture for the local serving issues in a separate PR. |
Thanks @sonupreetam . It was not an architecture issue. It was around mismatch between the UID/GID between the host and container user when writing to the mounted volume. I can submit a GitHub Issue to describe my environment. |
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 PRs).
Implementation Status: 4 of 4 tasks completed
Changes
1. Jekyll Documentation Site (
docs/)2. GitHub Actions Workflows
Jekyll Site Workflow (
.github/workflows/jekyll-site.yml):3. Dependabot Configuration
Adds
bundlerecosystem to.github/dependabot.yamlto ensure Jekyll Gems stay up-to-date with security patches and updates.4. 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 serveDesign Decisions: