schedkit/docs

Source for the schedkit documentation site, served at https://schedkit.io/.

The site is built with Docusaurus 3 and deployed to GitHub Pages by the workflow under .github/workflows/deploy.yml on every push to main.

Local development

npm install
npm run start

This boots a dev server on http://localhost:3000 with hot reload. Most edits to Markdown files under docs/ show up without a restart.

Building

npm run build

Output goes to build/. To verify the build locally before pushing:

npm run serve

Layout

docs/
  concepts/          # cross-cutting background: sched_ext, OCI schedulers, architecture
  schedctl/          # the host-side CLI
  sked/              # the Kubernetes operator
src/
  pages/             # standalone React pages (homepage)
  css/               # global styles
static/img/          # logos, diagrams, screenshots

The sidebar is generated from sidebars.ts. Files added under docs/ need to be wired in there unless they're part of an autogenerated section.

Writing style

A few things we try to keep consistent across the docs:

• Code blocks should be runnable. If a snippet needs adjustment for the reader's environment, say so explicitly.
• Prefer short, direct sentences. Resist the urge to write marketing copy.
• When something is a known limitation or rough edge, write it down. Future-you will thank present-you.
• Each page should make sense on its own; don't assume the reader arrived from the previous page in the sidebar.

License

Apache 2.0, matching the rest of schedkit. See LICENSE.