Skip to content

Build full documentation site with Jekyll and deploy to Pages - #296

Merged
jackgranatowski merged 3 commits into
mainfrom
claude/fervent-planck-93jh45
Jun 10, 2026
Merged

Build full documentation site with Jekyll and deploy to Pages#296
jackgranatowski merged 3 commits into
mainfrom
claude/fervent-planck-93jh45

Conversation

@jackgranatowski

Copy link
Copy Markdown
Contributor

Summary

Expands the GitHub Pages deployment to build and host a complete documentation site alongside the configurator app. The site is now built with Jekyll and includes a landing page, documentation, and the configurator all served from a single domain.

Key Changes

  • Expanded deployment scope: Changed from deploying only the configurator to deploying a full site with landing page, docs, and configurator
  • Added Jekyll integration: Configured Jekyll to process documentation markdown files with a custom default layout
  • Created landing page (index.md): Home page with quick links to configurator, demo, and documentation
  • Added default layout (_layouts/default.html): Shared HTML template for all pages with navigation, styling, and CSS framework integration
  • Updated Jekyll config (_config.yml): Added site metadata, plugins, exclusions, and layout defaults for docs and root paths
  • Added CNAME file: Configured custom domain slashed.codeslash.dev
  • Enhanced build workflow:
    • Builds root-level CSS bundles and docs first
    • Runs Jekyll to process markdown into HTML
    • Injects built CSS bundles, optional CSS, and configurator into the Jekyll output
    • Expanded path triggers to include core/, optional/, docs/, index.md, _layouts/, _config.yml, and CNAME
  • Improved caching: Added root package-lock.json to npm cache dependencies alongside configurator's

Implementation Details

The build process now follows this sequence:

  1. Install root dependencies and build CSS bundles
  2. Install and build the configurator app
  3. Run Jekyll to generate HTML from markdown in docs/ and root
  4. Copy built artifacts (CSS, optional CSS, configurator) into Jekyll's output directory

This approach ensures the framework's CSS is available for both the Jekyll-generated pages and the configurator app, with proper relative path resolution.

https://claude.ai/code/session_01JfFVxfZmv16PT2wo35P89S

Expands GitHub Pages from configurator-only to the full site:
  /                 — landing page listing all sections
  /docs/            — docs/*.md rendered via Jekyll + raw HTML files
  /docs/demo.html   — component showcase (uses built dist/ for CSS)
  /docs/test-coverage*.html — visual regression coverage reports
  /configurator/    — existing Svelte token configurator (unchanged)

Changes:
- CNAME: adds slashed.codeslash.dev for custom domain
- index.md: new landing page with nav to all sections
- _layouts/default.html: minimal layout using SLASHED's own CSS
- _config.yml: adds title/url, jekyll-optional-front-matter plugin
  (processes docs/*.md without needing per-file front matter),
  excludes non-doc directories from Jekyll
- deploy-configurator.yml: renamed to "Deploy to Pages"; builds root
  CSS bundles before Jekyll so demo.html relative paths resolve;
  adds Jekyll build step; injects dist/, optional/, configurator/
  into _site/ after Jekyll output

https://claude.ai/code/session_01JfFVxfZmv16PT2wo35P89S
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jackgranatowski, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 56 minutes and 55 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7934c9b9-bf7a-41ae-8214-a0066de4ecf2

📥 Commits

Reviewing files that changed from the base of the PR and between 393c8be and da292c9.

⛔ Files ignored due to path filters (1)
  • dist/badge-essential.json is excluded by !**/dist/**
📒 Files selected for processing (6)
  • .github/workflows/deploy-configurator.yml
  • CNAME
  • _config.yml
  • _layouts/default.html
  • configurator/src/data/api-index.generated.json
  • index.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/fervent-planck-93jh45

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jackgranatowski
jackgranatowski merged commit 20b88c9 into main Jun 10, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants