[docs] enhance docs site with new Jekyll theme, organized docs and local preview - #607
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
komer3
left a comment
There was a problem hiding this comment.
Looks sick! Thanks for adding this :)
There was a problem hiding this comment.
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, andmisetasks), 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.
…cal preview Signed-off-by: Moshe Vayner <moshe@vayner.me>
5551d4c to
500dcd4
Compare
Signed-off-by: Moshe Vayner moshe@vayner.me
miseTested everything locally, screenshots below
General:
Pull Request Guidelines: