The documentation that Driver generates about your codebase can be exported back to the repository. It's automation built for engineering workflows, where documentation tracks right alongside your code. Here's what to expect and how you can use the feature in your workspace.
Driver will push documentation back into your codebase in a dedicated driver_docs folder rendered in Markdown, with hyperlinks intact. With every commit, Driver automatically generates updates to the documentation. Updates are provided as pull requests so your team can review, merge, or ignore as needed. In the case of active codebases, say with multiple merges to the main branch in a single day, Driver will close pending PRs and submit a fresh one combining the content updates.
You can decide if and how you want Driver to manage these updates on a per-codebase basis in your workspace. If you prefer not to use this feature, Driver will continue working exactly as it does today.
For Github Users:
In Github, give the Driver app Read and write access to Content and Pull requests. If you're an existing user, you'll receive a GitHub email requesting permission to allow these permissions. Accept the request to enable the feature.
2. To turn on the features for existing codebases, go to My Sources and click on the overflow menu for the codebase you want to update. Select Codebase Settings to open the side panel below. Toggle Push Updates on or off.
3. To turn the feature on for new codebases, you'll get to set the Push Updates toggle on or off in the same side panel ahead of generating documentation for the first time.
For GitLab Users
In the main Driver app, go to Settings/Integrations to create a new group access token.
Give the new token the following additional permissions to allow Driver to create merge requests and push driver_docs to your repositories:
api
read_api
read_repository
write_repository