Skip to content
pagebeampagebeampagebeam docs

pagebeam

pagebeam checks each page of your docs against the product it describes. It says how sure it is. It opens a pull request with the fixes it can make. It is open source and runs in the repository you already have.

Try it

Section titled “Try it”

Run two commands in the repository that holds your docs:

Terminal window
npx pagebeam init
npx pagebeam check

init writes pagebeam.config.yaml. check only reads and reports. It writes nothing else and sends nothing anywhere.

Section titled “Read next”
  • Getting started: what init finds, and docs kept in another repository.
  • Run in CI: check every pull request.
  • Checks: the six checks and what each compares a page with.
  • Standing: what proven and review mean, and what can fail a build.
  • Configuration: every setting in pagebeam.config.yaml.
  • Proposals: drafting fixes with a model you choose, and what it sends.
  • CLI reference: commands, profiles and exit codes.