Skip to content

Create docs site#18

Merged
hholb merged 5 commits intomainfrom
hholb/docs
Mar 24, 2026
Merged

Create docs site#18
hholb merged 5 commits intomainfrom
hholb/docs

Conversation

@hholb
Copy link
Member

@hholb hholb commented Mar 18, 2026

Resolves: #13
Depends on: Garden-AI/rootstock-admin#3

Overview

This PR sets up a documentation website using zensical.

Screen.Recording.2026-03-18.at.2.57.27.PM.mov

The site is setup to be deployed on github pages using a github action, it should live at https://garden-ai.github.io/rootstock. We can think about a custom domain or pushing to readthedocs, but this is fine with me for now.

Testing the site locally

Install zensical
uv sync --extra dev

Run the local server:
uv run zensical serve

Details

The docs live in /docs and are a standard zensical setup of markdown files.

clusters.md has some custom JS to fetch manifests from the modal backend and render them as part of the docs. I had to get a little fancy to populate the table of contents in the right sidebar since typically that is built statically. Nothing too crazy, but it needed a bit of bespoke scrolling logic.

Screen.Recording.2026-03-18.at.2.55.18.PM.mov

@hholb hholb marked this pull request as ready for review March 24, 2026 15:55
Copy link
Contributor

@WillEngler WillEngler left a comment

Choose a reason for hiding this comment

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

Let's do it!

@hholb hholb merged commit f69a856 into main Mar 24, 2026
@hholb hholb deleted the hholb/docs branch March 24, 2026 16:16
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.

Documentation?

2 participants