Skip to content

site: migrate from Hugo/Docsy to VitePress#360

Merged
mchmarny merged 19 commits intomainfrom
docs/launch-prep
Mar 12, 2026
Merged

site: migrate from Hugo/Docsy to VitePress#360
mchmarny merged 19 commits intomainfrom
docs/launch-prep

Conversation

@tabern
Copy link
Copy Markdown
Contributor

@tabern tabern commented Mar 11, 2026

Summary

Replace Hugo/Docsy documentation site with VitePress. All 38 markdown docs migrated with content unchanged.

  • VitePress setup — Config with sidebar nav, local search, mermaid plugin, NVIDIA dark theme
  • Landing page — Vue SFC converted from React JSX prototype with scroll animations, workflow diagram, NVIDIA branding
  • Docs migration — Moved content/docs/ to docs/, renamed _index.md to index.md, added h1 headings, fixed internal links, escaped Go/Helm template syntax
  • CI/CD — Updated gh-pages workflow for VitePress build (npm ci && npx vitepress build)
  • Cleanup — Removed Hugo config, Go modules, Docsy theme, SCSS assets; added VitePress cache to .gitignore

Why

Hugo/Docsy is heavy for what we need (Go toolchain, theme modules, SCSS compilation). VitePress is markdown-native, simpler to maintain, and gives us Vue components for the landing page without a separate React build.

Test plan

  • cd site && npm ci && npm run build succeeds
  • Landing page renders at / with animations and workflow diagram
  • All 38 doc pages render with sidebar navigation
  • Search works across all docs
  • Mermaid diagrams render in contributor docs
  • Dark mode styling matches NVIDIA brand (#76B900)

tabern and others added 14 commits March 11, 2026 13:10
Restructure README to lead with what the project does, add quick start
showing full workflow (snapshot/recipe/validate/bundle), supported
environments, components table, and contributing guidance aligned with
launch materials.
Add docs/user/component-catalog.md listing every component that can
appear in a recipe, with descriptions and upstream links. References
recipes/registry.yaml as the source of truth. Linked from README and
user docs index.
- Update Go version from 1.25 to 1.26 in installation guide,
  contributor data docs, and copilot instructions
- Update golangci-lint version from v2.6/v2.9 to v2.10.1
- Expand API reference bundler list from 6 to all 18 registry
  components, reference registry.yaml as source of truth
- Fix Python and JavaScript API examples to send recipe as request
  body with bundlers as query params (matching curl examples and
  endpoint spec)
- Fix kubernetes-deployment.md claiming API server cannot generate
  bundles (it can via POST /v1/bundle)
- Replace hardcoded bundler list in copilot instructions with
  reference to registry.yaml
- Fix kubernetes-deployment.md agent Job example to show privileged
  mode (the default) instead of PSS-restricted mode. Add note about
  --privileged=false for restricted namespaces. Resolves contradiction
  with agent-deployment.md.
- Remove internal "v2" versioning from ROADMAP.md. External users have
  no context for v1 (internal playbooks) and the release version is
  0.10.x.
- Rename "Cluster Agent" to "Snapshot Agent" in README and correct
  description to reflect actual behavior (Job-based snapshot, not
  continuous monitoring)
- Replace broken kubectl apply -k deploy/aicrd with reference to
  full manifest (deploy/aicrd directory does not exist)
- Fix dead links to pkg/validator/checks/README.md in CONTRIBUTING.md
  and DEVELOPMENT.md — point to docs/contributor/validator.md instead
- Remove reference to nonexistent docs/monitoring/grafana-dashboard.json
Add AICR pipeline infographic showing the full workflow from ingest
through recipe generation, bundling, deployment, and validation.
Replaces the ASCII art diagram in the How It Works section.
- Restore skyhook-customizations, dynamo-crds, dynamo-platform, and
  kgateway-crds to component catalog to match all 18 entries in
  recipes/registry.yaml
- Fix typo: "include" → "included" in component-catalog.md
- Remove trailing whitespace in README.md
- Clarify kubectl apply comment to reference manifest section below
Replace Hugo/Docsy documentation site with VitePress. Content is
unchanged — all 38 markdown docs migrated as-is.

- Remove Hugo config, Go modules, Docsy theme, SCSS assets
- Add VitePress config with sidebar nav, local search, mermaid plugin
- Add custom NVIDIA dark theme (green #76B900, dark backgrounds)
- Add Vue landing page converted from React JSX prototype
- Add end-to-end workflow diagram (transparent PNG)
- Move content/docs/ to docs/, rename _index.md to index.md
- Add h1 headings from frontmatter title (VitePress requirement)
- Escape Go/Helm template syntax ({{ }}) in inline markdown
- Fix internal links for VitePress routing
- Update gh-pages workflow for VitePress build
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 11, 2026

Coverage Report ✅

Metric Value
Coverage 73.2%
Threshold 70%
Status Pass
Coverage Badge
![Coverage](https://img.shields.io/badge/coverage-73.2%25-green)

No Go source files changed in this PR.

mchmarny
mchmarny previously approved these changes Mar 11, 2026
- Rename Deployer Agnostic to Standards Based with updated description
- Add cosign to security card (SLSA, SPDX, Sigstore cosign)
- Simplify supported environments text (drop AKS/OKE/OpenShift, add COS)
- Remove Kind from environment cards
- Add curl install option to hero and quick start sections
- Update contributing section: make qualify, contributor docs link, GitHub link
@github-actions
Copy link
Copy Markdown

@tabern this PR now has merge conflicts with main. Please rebase to resolve them.

@mchmarny mchmarny enabled auto-merge (squash) March 12, 2026 00:01
@mchmarny mchmarny disabled auto-merge March 12, 2026 00:02
@mchmarny mchmarny merged commit 647d10b into main Mar 12, 2026
22 checks passed
@mchmarny mchmarny deleted the docs/launch-prep branch March 12, 2026 00:02
xdu31 pushed a commit to xdu31/aicr that referenced this pull request Mar 24, 2026
Co-authored-by: Mark Chmarny <mchmarny@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants