WalkLang Documentation

WalkLang docs are built into a static site for walklang.wlkrlabs.com/docs. This directory remains the source for the hosted documentation path.

Use this page as the docs front door. The root README explains the repository; these docs explain how to install, learn, use, verify, and evolve WalkLang.

Get Started

• Install WalkLang
• Build projects
• Learn the v1 syntax
• Read the v1 language contract

Use The Language

• Standard library
• Diagnostics and warnings
• Compatibility promise
• Migration guide
• Deprecation policy

Use The Tools

• Project mode and packages
• Editor tooling, LSP, docs generation, and debug maps
• Runtime and backend model
• Architecture

Track Versions

WalkLang version names use separate stability layers. The stable language contract is v1.9. The current compiler, tooling, backend, release, and docs milestone is v5.7.0. Experimental v2 through v2.2 language features are implemented, but they are not part of the stable v1 compatibility promise. Draft do:, io, parse, and process helpers are implemented for current compiler experiments and are not part of the stable v1.9 contract yet.

• v1 / v1.9 stable contract
• v2 data modeling, methods, and generics
• v3 package ecosystem
• v4 professional tooling
• v5 runtime and backend maturity
• v5.1 public docs and reference site
• Release notes
• Current status

Project Direction

• Roadmap
• Design rules
• Purpose
• Docs style guide

Generated Reference Docs

WalkLang supports rustdoc-style structured comments on public symbols. Generate Markdown and JSON reference output from real source with:

scripts/build-docs-site.sh

Reference docs under docs/reference/ are generated artifacts. The static site under public/ publishes the rendered docs pages, generated API reference, raw Markdown, and api.json from the same compiler output.

Hosting Contract

The public docs home is configured for:

walklang.wlkrlabs.com/docs

The target public scheme is HTTPS once GitHub Pages issues the custom-domain certificate. docs/STATUS.md records the current live HTTP/HTTPS state.

Use stable, relative links inside this directory so the same Markdown works in GitHub and on the hosted site. Run scripts/check-docs-site.sh before publishing docs changes.