Details on how AI Docs connects with GitHub, including repository syncing and webhook configuration.
AI Docs deeply integrates with GitHub to automate the generation and maintenance of your project documentation. This integration is fundamental to the platform's core value proposition, enabling seamless project creation, automatic synchronization of documentation with code changes, and secure access to your repositories. By leveraging GitHub, AI Docs ensures your documentation is always up-to-date and reflects the latest state of your codebase.
Connecting your GitHub account to AI Docs is a crucial step that unlocks the platform's full capabilities, especially for private repositories and automatic documentation updates.
When you connect your GitHub account, AI Docs gains the necessary permissions to:
You can connect your GitHub account via the User Settings page. This process involves an OAuth flow where you authorize AI Docs to access your GitHub resources. AI Docs requests the repo scope during this process, which is necessary to read your repositories.
AI Docs uses Google OAuth for user authentication and GitHub OAuth for repository access. These are distinct but complementary integrations. For more details on user authentication, refer