Skip to content

slsa documentation site

Servicereferenceservices/documentation-site

Checked by automation only

still a draft

Written 2026-10-30 by ktl-librarian (automation). Last checked 2026-10-27 by ktl-librarian (automation).

The full record
Checks
  • 2026-10-27 by ktl-librarian (automation)
Sources
Depends on
Graph
Open this concept in the knowledge graph
IRI
https://w3id.org/lmodel/slsa/knowledge/services/documentation-site
Licence
CC BY 4.0
Files
MarkdownJSON-LDSource on GitHubHistory on GitHub

website/ holds an Astro Starlight site that the ktl-website skill laid down. website/README.md says what each page is built from:

  • the README is the home page;
  • each page under docs/ is a page under docs/;
  • each concept in .lokf/knowledge/ is a page under knowledge/, with its trust label;
  • CHANGELOG.md is a page per release;
  • the schema’s gen-doc pages are pages under schema/.

The site also serves the four files lokf export writes under knowledge/.

.github/workflows/knowledge-website.yaml builds the site, with a check of every link between its pages:

  • on each push to the default branch that touches its inputs;
  • on each pull request that touches its inputs;
  • on a run by hand;
  • every Monday.

It deploys the default branch’s build to GitHub Pages only once the repository variable KNOWLEDGE_WEBSITE_ENABLED is true, and deploys nothing for a pull request.

website/site.config.mjs names docs/ as the docs folder in DOCS and gives it no sidebar groups, so every docs page sits in one Guides group, by title, with docs/index.md first as its Overview. docs/about.md is the only other docs page. DOCS.exclude keeps docs/templates-linkml/ off the site.

HOME in the same file gives the home page four buttons, in this order: Browse the bundle, Schema (the schema’s pages), Bundle health and Knowledge graph.

REDIRECTS in the same file sends three addresses the retired mkdocs site gave its pages on to their new pages: /elements to /schema/, each /elements/<name> to /schema/<name>/, and /about to /docs/about/. Its /elements/[...slug] entry stands for one redirect per schema page.

A link from a docs page to a file under docs/ that is no page of the site opens that file in the repository on GitHub. Such files are schema/slsa.yaml, schema/slsa_merged.yaml (the same schema with no imports) and Secure_Software_Factory_Whitepaper.pdf.

To preview the site, run npm ci --ignore-scripts and then npm run dev in website/. It needs Node.js 22.12 or later and uv.