Create docs for your cross repo PRs through AI assistance.

Capabilities

• Create docs in repo B on the basis of changes in repo A.
• Automatically selects the files to edit for documentation, based on the structure of the repo defined.

Benefits

• Easy documentation.
• Easy Setup.
• Document every single change at the appropriate place.
• Automated, so you just need to review the final PR created by the bot and decide whether you want to merge it in the main branch or not.

Getting Started

Just follow the setup steps mentioned below.

Setup Process:

1. In repo A (the repo to track for changes and document them), install this app and create a file called .github/pr-reviewer.yml.
2. In the above created file, add this line: mirror-repo: the path of the repo. For instance, mirror-repo:slashml/magemaker.

That's it you're all set. Now whenever you will create a new PR, it will automatically check it, generate relevant documentation based off of the changes and in repo B that you have specified, i.e., slashml/magemaker, it will choose the specific file to edit. It will create a separate branch on top of your default branch (main or master) and then create a PR in the repo B for your review.