CASEDD Documentation

Welcome to the official CASEDD docs site. The jekyll-theme-leap-day theme is now active for modern typography, spacing, and readability.

This site uses GitHub Pages from the docs/ folder on the main branch.

Quick links

• Project README
• Getter docs
• Template format
• REST API descriptor

Tips

1. Ensure docs/.nojekyll is removed in the branch (Jekyll mode).
2. Ensure repository Pages source is set to main/docs.

• README content is available from docs/README.md (synced from /README.md).
• User documentation is in docs/getters.md and docs/template_format.md.

README content in docs

docs/README.md is a copy of the project README and provides full project overview, quick start, configuration, and architecture information.

User docs

• Getter key reference
• Template format
• REST API / docs descriptor

Example templates

• templates/system_stats.casedd
• templates/push_demo.casedd
• templates/fans.casedd
• templates/slideshow.casedd
• templates/stats_over_slideshow.casedd

For full template examples, see the repository template folder here:

• templates/

Setup in GitHub

1. Go to repository Settings > Pages.
2. Under “Source”, set it to docs/ folder on the main branch.
3. Remove docs/.nojekyll from the branch to enable Jekyll processing.
4. Save.

Once active, the site should be available at:

• https://<your-org>.github.io/casedd

Local sync helper

To keep docs README in sync with root README:

./scripts/sync_docs_to_pages.sh