# pagebeam

> pagebeam checks each page of your docs against the product it describes, says how sure it is, and opens a pull request with the fixes it can make.

pagebeam is a command line tool. Run it with `npx pagebeam`. Each finding is proven (the source of truth says so) or review (worth a look, not proof). Only proven findings can fail a build, and only under an enforcing profile.

## Documentation Sets

- [Abridged documentation](https://docs.pagebeam.dev/llms-small.txt): a compact version of the documentation for pagebeam, with non-essential content removed
- [Complete documentation](https://docs.pagebeam.dev/llms-full.txt): the full documentation for pagebeam

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [pagebeam source on GitHub](https://github.com/pagebeam/pagebeam)