github-actions documentation site

github-actions documentation site

website/ holds an Astro Starlight site, which the README describes as built from the README, docs/, the schema’s pages and the knowledge bundle.¹ website/site.config.mjs names the repository lmodel/github-actions, the address https://lmodel.github.io and the base path /github-actions.² So its pages are served under https://lmodel.github.io/github-actions/. NOTICE says that the site derives from the ktl-website templates.

What the pages come from

website/README.md says that every page comes from a file the repository already holds, so a change to the site is a change to that file:³

• each concept in .lokf/knowledge/ becomes a page under knowledge/, with its trust label from knowledge-report.sh, its sources and its typed relations both ways, and the four files lokf export writes are served beside them, with the bundle log as an Atom feed, knowledge/log.xml;
• the README becomes the home page, and each page under docs/ a page under docs/, except docs/templates-linkml/, which site.config.mjs leaves out;
• CHANGELOG.md becomes a page per release under changelog/;
• the schema’s pages, which gen-doc writes into docs/elements/, become a page each under schema/.

site.config.mjs shows no data pages, since BROWSE is null. Its REDIRECTS send the addresses that the retired mkdocs site gave its pages on to the new ones: /elements and each /elements/<name> to /schema/, and /about to /docs/about/.

Previewing it

Previewing needs Node.js 22.12 or later and uv. In website/, run npm ci --ignore-scripts, then npm run dev for a local server, or npm run build, which writes dist/ and then checks every link between its pages. Both run npm run sync first, which runs lokf export from the sidecar’s environment in .lokf/ and writes the generated pages. Nothing the sync writes is committed.

Publishing it

Knowledge website builds the site on pull requests and on the default branch, and deploys it to GitHub Pages only once the repository variable KNOWLEDGE_WEBSITE_ENABLED is true.

Editing it

Change a page’s words in the file it comes from: the README, a page under docs/, the schema, or a concept, which goes through the librarian and the curator like any other change to the bundle. Change the site’s options in site.config.mjs, and its look in src/styles/custom.css, which is the repository’s own.

Footnotes

1. README.md, the website item of Repository Structure ↩

2. website/site.config.mjs, REPO, SITE, BASE, DOCS, REDIRECTS, CHANGELOG, SCHEMA and BROWSE ↩

3. website/README.md, the list of page sources, Preview it and What to edit ↩