WalkLang Public Docs And Reference Site

WalkLang documentation is publishable as a static site without changing the language surface.

Site Surface

The static site builds into:

public/

The hosted path is configured for:

walklang.wlkrlabs.com/docs

The generated site includes:

public/index.html
public/docs/index.html
public/docs/reference/api.html
public/docs/reference/api.md
public/docs/reference/api.json

The site is static HTML/CSS. It does not ship JavaScript assets.

public/CNAME sets the custom domain to walklang.wlkrlabs.com for static hosts that honor CNAME files.

HTTPS is the public scheme for the custom domain, and HTTP redirects to HTTPS. docs/STATUS.md records the latest checked live HTTP/HTTPS state.

Reference Generation

The reference source remains real WalkLang code with structured comments:

examples/stable.walk
examples/math_extra.walk

Build the site and generated reference artifacts with:

scripts/build-docs-site.sh

The script builds and uses the C++/C walk compiler by default for structured API docs and static site generation. The previous Go site generator and JavaScript search asset have been removed.

Check that generated artifacts are fresh and that static links resolve with:

scripts/check-docs-site.sh

Public Path Safety

Generated reference docs use repository-relative source paths such as:

examples/stable.walk
examples/math_extra.walk

Do not publish generated docs that contain local absolute paths.

CI And Deploy

CI runs the docs-site check before building release artifacts. The Pages workflow builds public/ and uploads it as a GitHub Pages artifact from main.

Non-Goals

The public docs and reference site do not add:

networking
interactive playground
compiler explorer
online package index
new language syntax