Builds the OpenShell docs site from the docs of several repositories. Each repository keeps its docs next to its code and ships them with its releases. This repository holds no page content: it owns the build, the theme, and the navigation.
| Docset | Repository | Path | Versions |
|---|---|---|---|
| OpenShell | NVIDIA/OpenShell | docs/ |
dev (main), 0.1.9, 0.1.8, 0.1.7 |
| Go SDK | ai-openshell/sdk-go | docs/src/ |
dev (main), 0.1.8, 0.1.7 |
sources.yml lists each repository, where it's mounted, and
which tags to publish. The build fetches only the docs directory at each tag or
branch, reads it in its own format (Fern index.yml, mdBook SUMMARY.md, or
docset.yml), checks every link, and builds the site with
Starlight. Each version is published at its
own path, such as /0.1.8/about/overview/ or /sdks/go/dev/.
Broken links in fetched versions are warnings, so one repository can't block
the site. To check a change to a repository's docs, build with --local (see
CONTRIBUTING.md), where broken links are errors. Pull request
previews for source repositories are tracked in
#2.
To publish a new release, add its tag to sources.yml.
mise install
mise run install
mise run build
mise run serveSee CONTRIBUTING.md for more.