To create great documentation, GitDocAI needs to understand your product. You connect sources by picking a source type in the wizard — either when you first create a documentation or whenever you add a new section. Each section keeps its own sources, so you can sync one from a GitHub repo and another from a PDF without mixing them up.
The wizard's source types
Whether you're creating a new documentation or adding a section to an existing one, the wizard offers the same set of starting points. Pick the one that matches the material you're working with:
The source type also determines what kind of section GitDocAI produces. Sync from GitHub creates product documentation. OpenAPI creates an API Reference. Import from website mirrors the site's structure. There's no separate "section type" picker — the source shapes the result.
Adding sources to an existing documentation
From the editor header, click + next to the section tabs to launch the same wizard. Walk through the steps:
Click + in the section tab bar.
Choose one of the six options above (Sync from GitHub, Describe with AI, Import from website, Upload files, OpenAPI, or Blank).
Depending on the source type: pick a repo, paste a URL, upload files, upload a spec, or write a prompt.
Hit Generate. Progress streams live, page-by-page, until the section is ready to edit. (Blank skips the generation step — you go straight into the empty editor.)
The dedicated Resources page no longer exists. Sources are managed inline per section — open a section and use the Source sidebar to add, remove, or re-sync resources. See Re-sync & Pending Changes for keeping a generated section in step with its sources over time.
Connecting GitHub repositories
The most powerful way to document software is by connecting your codebase directly. GitDocAI reads code, configuration, and Markdown to understand how your project works.
From the Integrations page, click Connect GitHub to install the GitDocAI app on your personal account or organization, then select the repositories you want to expose. Once installed, those repos become available everywhere GitDocAI lets you pick a source.
When you choose Sync from GitHub in the wizard, the repository picker lists everything the app has access to. Repositories are auto-synced the first time you open the picker after installing the app, so you don't need to hit a refresh button.
Choose between the full repo, a specific folder, or a single file — useful for monorepos where only one slice is relevant to a given section.
GitDocAI automatically respects your .gitignore patterns and never reads files you've intentionally excluded. If GitHub later suspends or revokes the installation, the integration is flagged in the dashboard so you can re-authorize.
Uploading files
You can upload individual files directly to a section. GitDocAI doesn't just read text — it uses Vision AI to understand images and transcribes audio and video automatically.
Text & Markdown:
.txt,.md,.markdown,.mdx,.rst,.logStructured data:
.csv,.json,.yaml,.yml,.xml,.htmlCode:
.py,.js,.jsx,.ts,.tsx,.go,.rs,.java,.c,.cpp,.h,.cs,.rb,.php,.swift,.kt,.scalaConfiguration:
.toml,.ini,.cfg,.confStyles:
.css,.scss,.sass,.lessDocuments:
.pdf,.docx,.doc,.pptx,.ppt,.xlsx,.xlsImages:
.png,.jpg,.jpeg,.gif,.bmp,.webp,.tiffVideo:
.mp4,.mov,.webm,.mkv,.avi, and moreAudio:
.mp3,.wav,.m4a,.flac,.ogg, and more
Importing websites
When you pick Import from website, the wizard asks for an entry URL and offers two modes:
Single Page — scrape only the URL you provide.
Full Site — crawl the entire site starting from the entry URL. Switching between modes is a single click in the wizard.
GitDocAI uses multiple smart strategies to bypass CAPTCHAs and render Single Page Applications, so you get clean content even from JavaScript-heavy sites.
Generating from OpenAPI
When you pick the OpenAPI / Swagger source, the wizard offers two paths:
Upload the spec file directly (
.yaml,.yml, or.json).Repository file — pick a connected repo and the file path inside it (e.g.,
openapi.yaml). Useful when the spec is generated by your build pipeline and lives at a stable path.
GitDocAI is permissive about spec shape: even Swagger 2.0 and auto-generated specs that don't validate strictly will still produce a reference. See Documenting APIs and Workflows for what's generated and how to refine the result.
Describe with AI (custom prompts)
No source files yet? Pick Describe with AI in the wizard and write what you want documented in plain English. The AI generates the content based on your instructions and can pull in live web context to flesh out details.
Example prompt:
Document our REST API for booking management. Cover authentication, rate limits, and the main endpoints for creating, viewing, and canceling reservations. Use a friendly tone aimed at backend developers.
Starting blank
The Blank option skips ingestion entirely — the wizard creates an empty section and drops you into the editor. From there you can write pages by hand, paste in MDX, or drive everything from a connected MCP client. You can always add sources later via the Source sidebar if you decide to start ingesting material.
The generation process
Once sources are connected (for any source type except Blank), generation runs in real time. The wizard streams progress so you can watch the section come together page-by-page, with the title of the current page surfaced in the status line. Generation typically takes 1–3 minutes depending on how much source material you connected.
After generation completes, the section's sources remain attached. Use the Source sidebar inside the editor to inspect or change them, and trigger a re-sync when the underlying material changes — GitDocAI will stage the differences as pending proposals you can review before they touch the live content.