gen-errors-page

command
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

gen-errors-page regenerates the public-facing errors reference at `docs-web/docs/reference/errors.md` from the canonical per-code markdown files under `core/error_docs/*.md` (the same files that power `rad docs <code>`).

The pipeline:

core/error_docs/<code>.md   ── source of truth (per-code)
      │
      ▼ gen-errors-page (this binary)
docs-web/docs/reference/errors.md   ── derived aggregate

The hand-written preamble lives in `tools/gen-errors-page/preamble.md` and is prepended verbatim.

Layout:

  • `## <Band>` section per error-code band (1xxxx Syntax, 2xxxx Runtime, 3xxxx Type, 4xxxx Validation/Lint), in numeric order.
  • Within a band, each code's doc in numeric order, with its headings demoted two levels so the per-file `# RAD10001: Title` becomes a `###` entry under the band's `##`.

Usage:

go run ./tools/gen-errors-page

Defaults assume invocation from the repo root. Pass `-source` and `-out` to override.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL