# pagebeam

> pagebeam checks every page of your documentation against the application it describes, says how sure it is, and opens the pull request that fixes what it can. Open source, in the repository you already have.

pagebeam is a command line tool, run with `npx pagebeam`. It reads documentation where it already lives (Markdown, MDX, Astro) and the application beside it, and reports findings grouped by page. Each finding is either proven (the source of truth says so) or review (worth a look, not proof). Only proven findings can fail a build.

## Docs

- [Getting started](https://docs.pagebeam.dev/getting-started/): install, write a config with `init`, run `check`
- [Run in CI](https://docs.pagebeam.dev/getting-started/ci/): the GitHub Action, with the docs and the product in one repository or two
- [Checks](https://docs.pagebeam.dev/checks/): links, configKeys, openapi, strings, moved, undocumented
- [Standing](https://docs.pagebeam.dev/checks/standing/): what proven and review mean, and what can fail a build
- [Configuration](https://docs.pagebeam.dev/configuration/): every key in pagebeam.config.yaml
- [Proposals](https://docs.pagebeam.dev/proposals/): drafting fixes with a model you choose, and what leaves the machine
- [CLI reference](https://docs.pagebeam.dev/cli/): commands, profiles and exit codes

## Source

- [GitHub repository](https://github.com/pagebeam/pagebeam): MIT licensed source
- [npm package](https://www.npmjs.com/package/pagebeam): published releases

## Optional

- [Full documentation as one file](https://docs.pagebeam.dev/llms-full.txt)
- [This site as one file](https://pagebeam.dev/llms-full.txt)