Skip to content

Repository files navigation

OpenSourceOps GitHub Pages

This repository builds the organization root site and the public agentctl documentation at /agentctl/. Technical content is canonical in opensourceops/agentctl; a deterministic manifest imports it into an Astro and Starlight presentation layer.

Prerequisites

  • Node.js 22 or newer
  • pnpm 11.9.0 through Corepack
  • Rust 1.88.0 and Cargo
  • Python 3.11 or newer for cookbook tooling (asset packaging uses the standard library; executing downloaded examples installs their pinned requirements)
  • Playwright Chromium for the full browser gate
  • local checkouts of this repository and agentctl

Set AGENTCTL_REPO when the agentctl checkout is not in a documented sibling location.

Local development

corepack enable
pnpm install --frozen-lockfile
pnpm exec playwright install chromium
AGENTCTL_REPO=/path/to/agentctl pnpm docs:sync
pnpm dev:agentctl

The development URL is http://localhost:4321/agentctl/. The development server makes no provider request, but dependency installation can use the package registry.

Build and verify

AGENTCTL_REPO=/path/to/agentctl pnpm build
AGENTCTL_REPO=/path/to/agentctl pnpm verify:agentctl

pnpm build writes the complete Pages artifact to _site; serve that directory at its root and open /agentctl/. pnpm verify:agentctl is the canonical cross-repository gate. It runs cargo xtask docs-verify, synchronizes canonical content, checks writing, spelling, links, anchors, Mermaid, search, and generated freshness, builds the final artifact, then runs responsive Playwright and axe checks.

Common failures are a missing AGENTCTL_REPO, stale generated source or CLI references, a missing Playwright browser, or another process using port 4173. No verification command needs a provider API key.

Source ownership, routes, content digests, and the exact framework commit remain in public/meta/agentctl-source.json; imported pages keep their source edit links. The importer does not append provenance boilerplate to the page body. When updating framework content, follow the paired source update before running the freshness gate.

All twenty cookbook READMEs are imported at stable examples/devops/<directory>/ routes. Synchronization calls the framework's standard-library package.py to generate each complete downloadable ZIP, including its helper and setup script. ZIP hashes, source revisions, and tutorial routes are recorded in downloads/devops/catalog.json and source metadata. Installation commands and source links use the paired framework commit instead of silently pointing candidate readers at main.

See deployment settings and the current cookbook review ledger. The older execution documents retain evidence from their stated dates.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages