Skip to main content

Proactive PRs

RunLLM can also help you proactively maintain your documentation to keep it up to date with your product as the product changes. You can connect RunLLM to your code repository and your documentation repository (or keep both in the same repo) in GitHub. When a new PR is made to update your product, you can ask RunLLM to update the documetnation correspondingly if that PR is customer-facing. RunLLM will determine which parts of the documentation need to be changed and create a new PR against your documentation to keep it in sync with the code.

Here's how it works:

  1. Connect RunLLM to your documentation and code repository pair. You can either point RunLLM at two separate repositories or one repo that has both your product dode and your documentation. AutoDocs PR setup
  2. Once you connect your repository, RunLLM will show you a list of open PRs on your repository. If any of these PRs affect your product documentation, you can click Generate PR on the right side of the UI. Within a few seconds, RunLLM will open a new PR that automatically updates your documentation repository. AutoDocs PR list
  3. The generated PR will look something like this. The description will include a comprehensive list of the change made, and the edits will directly update the code files.
Iterating on documentation changes

We're working on adding support for updating documentation based on feedback you provide about the changes. Stay tuned for more!