Repository navigation
docs: Break down README into smaller units #1558
Description
Activity
- added a parent issue
on May 22, 2025 - changed the title
[-]**docs**: Refactor the README into smaller, more targeted documentation pages.[/-][+]docs: Break down README into smaller units[/+]on May 22, 2025 We've done the first part here where the readme content and homepage content are in sync and generated in a more reliable way.
The next part is to break out some sections from the readme to be their own pages.
I think Configuration would be a good top level section in the docs site with sub pages for:
- ignoring files
- rego version
- roots
- capabilities
I think another page for CLI, detailing exitcodes and formats would be helpful to reduce the volume of the readme.
We are interested in using the blocks of content to build the readme and parts of the regal docs to make the correct content appear in the correct places without duplication and error prone markdown templating.