Repository navigation
chore: initialize the docs site repository - #1
Merged
Merged
Conversation
Set up the multi-repo docs site from the docs prototype, with the OpenShell core and Go SDK docsets. Node.js is pinned with mise. Adds LICENSE, SECURITY.md, CONTRIBUTING.md, AGENTS.md and Dependabot from the OpenShell repository template. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Broken links in a source repo's dev branch failed the whole site build, so one repo could block the site. Fetched versions now only warn, and CI shows each warning as an annotation. Previews, --local checkouts and this repo's own pages stay strict, so each repo still catches its own problems. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
pimlock
force-pushed
the
chore/init-repo/pimlock
branch
from
November 17, 2026 23:07
0f6bdb9 to
b8a3e34
Compare
Add Biome for formatting and linting (warnings fail) and astro check for type checking, both run in CI. Format the code, fix the lint findings, and type Astro.locals so components no longer use any. Header imports Starlight's public components instead of virtual modules. The built site is unchanged apart from formatting. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Remove the reusable preview workflow, the assembler's preview mode (remote versions from links.json, inbound link guard, fragment layout, diff view) and links.json, which only previews read. Previews are tracked in #2 and will ship separately. The built pages are unchanged. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Unit-test the docset.yml, Fern and mdBook readers, and run the assembler end to end against two local git repos: link rewriting, repo:// links, redirects, warnings for fetched versions, and errors for a --local checkout. Tests use node:test, run offline, and run in CI. Add --sources so the assembler can read another sources.yml. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Add SPDX-License-Identifier: Apache-2.0 to every file, with .license sidecars for JSON and images, and run ai-openshell/workflows' spdx-check on pull requests. The CNCF logos are third-party and excluded. The mdBook reader now drops a page's H1 after leading comments, such as an SPDX header, and the readers and site sync skip .license sidecars so they are never published. Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
TaylorMutch
approved these changes
Nov 18, 2026
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
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.
Summary
Sets up the docs site: a Starlight site assembled from the docs of several repositories, starting with two docsets.
docs/main), 0.1.9, 0.1.8, 0.1.7docs/src/main), 0.1.8, 0.1.7Changes
sources.yml.Siteworkflow: builds on pull requests, and builds and deploys to GitHub Pages frommain.--localcheckout.mise.tomlpins Node.js and adds tasks:build,serve,test,lint,format,typecheck.astro checkfor type checking, andnode:testunit tests. All run in CI.LICENSE,SECURITY.md,CONTRIBUTING.md,AGENTS.md, and Dependabot.ai-openshell/workflowsspdx-check.Testing
mise run build,mise run test,mise run lint, andmise run typecheckpass; CI is green./latest/pages.