Skip to content

[docs] enhance docs site with new Jekyll theme, organized docs and local preview - #607

Merged
AshleyDumaine merged 1 commit into
mainfrom
jekyll-docs
Aug 20, 2026
Merged

[docs] enhance docs site with new Jekyll theme, organized docs and local preview#607
AshleyDumaine merged 1 commit into
mainfrom
jekyll-docs

Conversation

@moshevayner

@moshevayner moshevayner commented Aug 20, 2026

Copy link
Copy Markdown
Member

Signed-off-by: Moshe Vayner moshe@vayner.me

  • Implement a dynamic Jekyll theme including a mode switcher between dark/light/system modes.
  • Nav pane on the left with ordered sections
  • Local preview ability using mise

Tested everything locally, screenshots below

image image

General:

  • Have you removed all sensitive information, including but not limited to access keys and passwords?
  • Have you checked to ensure there aren't other open or closed Pull Requests for the same bug/feature/question?

Pull Request Guidelines:

  1. Does your submission pass tests?
  2. Have you added tests?
  3. Are you addressing a single feature in this PR?
  4. Are your commits atomic, addressing one change per commit?
  5. Are you following the conventions of the language?
  6. Have you saved your large formatting changes for a different PR, so we can focus on your work?
  7. Have you explained your rationale for why this feature is needed?
  8. Have you linked your PR to an open issue

@github-actions github-actions Bot added the documentation for updates to the documentation in the changelog. label Aug 20, 2026
@codecov

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.21%. Comparing base (32becc3) to head (500dcd4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #607   +/-   ##
=======================================
  Coverage   75.21%   75.21%           
=======================================
  Files          18       18           
  Lines        2679     2679           
=======================================
  Hits         2015     2015           
  Misses        453      453           
  Partials      211      211           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@komer3
komer3 requested a lite review from Copilot August 20, 2026 15:47

@komer3 komer3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks sick! Thanks for adding this :)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR introduces a GitHub Pages/Jekyll documentation site for the Linode Cloud Controller Manager repo, adding a Just-the-Docs-based theme (including a light/dark/system mode switcher), reorganizing existing docs into a structured nav hierarchy, and providing local preview/build commands via make and mise.

Changes:

  • Added Jekyll site configuration and theme customization (custom SCSS + header/head includes for theme switching).
  • Added/updated docs pages with Just-the-Docs front matter to organize navigation (Getting Started / Configuration / Examples / Development).
  • Added local docs preview/build tooling (make serve-docs, make build-docs, and mise tasks), plus Jekyll build artifacts to .gitignore.

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mise.toml Adds serve-docs/build-docs tasks to run the new Make targets.
Makefile Adds Docker-based local docs serving/building targets and related variables.
index.md Creates a Jekyll home page that renders the repo README with link rewriting.
docs/getting-started/README.md Adds front matter for nav organization of Getting Started section.
docs/getting-started/overview.md Adds front matter for Getting Started nav ordering.
docs/getting-started/requirements.md Adds front matter for Getting Started nav ordering.
docs/getting-started/installation.md Adds front matter for Getting Started nav nesting.
docs/getting-started/helm-installation.md Adds front matter for Installation subpage nav nesting.
docs/getting-started/manual-installation.md Adds front matter for Installation subpage nav nesting.
docs/getting-started/verification.md Adds front matter and improves markdown formatting consistency.
docs/getting-started/troubleshooting.md Adds front matter and improves markdown formatting consistency.
docs/configuration/README.md Adds front matter for Configuration Guide section.
docs/configuration/loadbalancer.md Adds front matter for Configuration Guide nav nesting.
docs/configuration/annotations.md Adds front matter and adjusts table formatting for better rendering.
docs/configuration/nodes.md Adds front matter and improves markdown spacing/readability.
docs/configuration/environment.md Adds front matter and fixes a broken external link format.
docs/configuration/firewall.md Adds front matter and improves markdown spacing/readability.
docs/configuration/routes.md Adds front matter and improves markdown spacing/readability.
docs/configuration/session-affinity.md Adds front matter and improves markdown spacing/readability.
docs/configuration/nodeipam.md Adds front matter and improves markdown spacing/readability.
docs/examples/README.md Adds front matter for Examples section nav ordering.
docs/examples/basic.md Adds front matter and minor formatting spacing.
docs/examples/advanced.md Adds front matter for Examples nav nesting.
docs/development/README.md Adds front matter for Development Guide section nav ordering.
.gitignore Ignores Jekyll local build artifacts.
_sass/custom/custom.scss Adds custom CSS overrides and styling for the theme toggle.
_includes/header_custom.html Adds the theme toggle button markup and click handler.
_includes/head_custom.html Adds early-loading script to apply persisted theme choice before paint.
_config.yml Adds Jekyll/Just-the-Docs configuration, plugins list, and excludes for non-doc content.
_config.yaml Removes the old config file in favor of _config.yml.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread _includes/head_custom.html Outdated
…cal preview

Signed-off-by: Moshe Vayner <moshe@vayner.me>
@AshleyDumaine
AshleyDumaine enabled auto-merge (squash) August 20, 2026 16:11
@AshleyDumaine
AshleyDumaine merged commit b9aa901 into main Aug 20, 2026
12 checks passed
@AshleyDumaine
AshleyDumaine deleted the jekyll-docs branch August 20, 2026 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation for updates to the documentation in the changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants