Skip to main content

Maintaining the command reference

The command reference is generated from the public functions and comment-based help in the adjacent Keldor source repository. Source metadata controls command names, syntax, parameters, examples, inputs, outputs, and online help links. The source manifest controls the exported alias list.

From the documentation repository, run:

./scripts/Sync-KeldorPowerShellDocs.ps1

The script performs the following checks before replacing pages:

  • Every public source file parses and contains exactly one top-level function.
  • The declared function name exactly matches the case-sensitive filename.
  • No public command names are duplicated.
  • The generated command and alias sets match the source inventory.
  • Each current public command receives one page.
  • Obsolete command-reference pages are removed.

The script writes api-audit.json beside the command pages for machine-readable set comparison. It requires PowerShell 7.4 or later and platyPS 0.14.2 or later.

After synchronization, run the site type check and production build:

npm run typecheck
npm run build

Review the generated diff and the source comment-based help before publishing. Windows-only command metadata can be generated on other platforms, but behavior should be runtime-tested on Windows.