Create docs site - #18
Merged
Merged
Conversation
hholb
marked this pull request as ready for review
March 24, 2026 15:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 devRun the local server:
uv run zensical serveDetails
The docs live in
/docsand are a standard zensical setup of markdown files.clusters.mdhas 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