Skip to content

Conversation

@sonupreetam
Copy link

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).

  1. Provides a documentation website
  2. Automatically deploys to GitHub Pages
  3. Generates automated markdown documentation directly from CUE schemas
  4. Dependabot bundler configuration
  5. Includes comprehensive tutorials for users and contributors

Implementation Status: 4 of 7 tasks completed

  • Jekyll infrastructure
  • Deployment workflow
  • Dependabot configuration
  • Makefile targets
  • Schema docs automation workflow (follow-up)
  • CUE documentation generator (follow-up)
  • Tutorial documentation (follow-up)

Changes

1. Jekyll Documentation Site (docs/)

2. Automated Schema Documentation Generator (utils/cuedocs/main.go) - IN Progress

3. GitHub Actions Workflows

Jekyll Site Workflow (.github/workflows/jekyll-site.yml):

4. Dependabot Configuration

Adds bundler ecosystem to .github/dependabot.yaml to ensure Jekyll Gems stay up-to-date with security patches and updates.

5. Makefile Enhancements

New targets for documentation workflow:

make serve      # Start local Jekyll development server
make build      # Build static site locally
make stop       # Stop Jekyll server
make clean      # Clean generated files and containers

Testing

Local Testing

make serve
# Visit http://localhost:4000
make stop

Verified:

  • Site builds without errors
  • Navigation works correctly
  • Styling renders properly

CI Testing

  • Jekyll site builds successfully in GitHub Actions
  • Security checks passed
  • Path filtering triggers correctly

Related Issues

Partially resolves issue #155

Checklist

  • Clear title conforming to Conventional Commits spec
  • Descriptive commit message
  • DCO signoff on commits (git commit -s)
  • All CI checks pass (will verify after push)
  • No breaking changes
  • Security best practices followed

Additional Notes

For Reviewers:

  • Bulk of changes are in docs/ directory (Jekyll site structure)
  • Local preview recommended: make serve
  • This is a foundational PR; automated schema documentation will follow
  • Scope: Comprehensive documentation infrastructure with automation

Next Steps:

  • Add CUE documentation generator (utils/cuedocs/)
  • Implement schema docs automation workflow
  • Import existing README to create tutorials
  • Note: All schema docs are auto-generated.

Design Decisions:

  • Jekyll over MkDocs: Chosen for consistency with potential OpenSSF Security Baseline styling and GitHub Pages integration
  • Auto-generation: Schema docs generated from CUE ensures single source of truth
  • Maintenance Plan: Dependabot configured for Gem updates; other maintenance process will be documented

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 21, 2025
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 <spreetam@redhat.com>
@sonupreetam sonupreetam force-pushed the docs/jekyll-documentation-site branch from 51faea7 to 2f94ee8 Compare November 21, 2025 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consider adding a website for Gemara

1 participant