Today’s release brings Driver Docs directly into your GitHub and GitLab repos, and we’re rolling out public API docs for C. This is a major step towards making documentation a more seamless part of your development workflow—and we’re just getting started. From live IDE integrations to full-site publishing, here’s what’s new, what’s next, and a look ahead.
Automatically Updated Documentation, Now in Your GitHub and GitLab Repos
Driver Docs are now inside your GitHub and GitLab codebases. The documentation lives 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. It’s automation built for engineering workflows, where documentation tracks right alongside your code.
For GitHub users: You’ll receive an email from GitHub requesting permission to allow Driver to create branches and pull requests. Accept the request to enable this feature. If you decline, no worries—Driver will continue working as it does today, with no interruptions.
We're also updating the permissions required for GitLab group access tokens to enable automatic documentation updates. You’ll need to create a new group access token with additional permissions (api, read_api, read_repository, and write_repository) to allow Driver to create merge requests and push driver_docs to your repositories.Please create and update your token in Driver's integration settings to enable this new feature. If you prefer not to update your tokens right now, also no problem—Driver will continue working exactly as it does today with no interruptions to your existing workflows. The only difference is you won't have access to the new automated documentation feature that pushes driver_docs via merge requests.
Public API Documentation for C
Driver now auto-generates crisp public API documentation for every public function declared in your C header files, giving API consumers everything they need while keeping your proprietary logic under wraps. Driver documents crucial contracts—parameter expectations, memory ownership, error returns, and edge-case behavior—but doesn’t reveal implementation bodies, algorithms, or other proprietary details.