faberlang.dev

Source for faberlang.dev, the documentation site for the Faber programming language. Faber is experimental through version 1.

Layout

• src/en-US/ Markdown pages (the maintained prose tree)
• static/ files copied as-is: install.md, llms.txt, the agent guides in agents/ and the agent skills in .well-known/agent-skills/
• generator/ the site generator (Python) and its stylesheet
• dist/ the generated site, committed; this is what gets published

Pages generated from the compiler (grammar, locale tables, corpus, agent reference) come from a pinned Faber commit in generator/upstream.lock.toml.

Build

Needs Python 3.11 or newer and a faber binary built from the pinned commit.

bash generator/scripts/build-site.sh --faber /path/to/faber   # incremental
bash generator/scripts/build-site.sh --full --faber /path/to/faber

The build renders dist/, runs the link, leakage and width checks and writes sitemap.xml; it stops on any failure. Commit src/, static/ and dist/ together. AGENTS.md covers the pin, generated pages and checks.

Deploy

A push to main runs .github/workflows/deploy-pages.yml, which uploads dist/ as a GitHub Pages artifact and publishes it at https://faberlang.dev. The workflow does not build anything, so dist/ must be current when you push.

License

faberlang.dev is written by Ian Zepp. The site, its Markdown sources, the generator, and the agent skills and guides it publishes are available under either of the MIT license or the Apache License, Version 2.0, at your option (LICENSE-MIT, LICENSE-APACHE), the same terms as faberlang/faber. Contributions are dual-licensed under the same terms.