# DocuWriter Documentation

Official DocuWriter documentation: connect repositories, generate complete documentation, manage Spaces, keep documentation current with Autopilot, and integrate with the API.

Request any document URL with `Accept: text/markdown` to read it as Markdown.

## Start here

- [What is DocuWriter?](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/what-is-docuwriter)
- [Create your first documentation Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/create-your-first-documentation-space)
- [Repositories, Spaces, pages and generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/start-here/repositories-spaces-pages-and-generations)
## Connect your code

- [Connect a Git repository](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-a-git-repository)
- [Connect GitHub](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-github)
- [Connect GitLab](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-gitlab)
- [Connect self-hosted GitLab](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-self-hosted-gitlab)
- [Connect Bitbucket](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-bitbucket)
- [Connect Azure DevOps](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/connect-azure-devops)
- [Document a one-time project ZIP](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/document-a-one-time-project-zip)
- [Troubleshoot repository connections](https://docs.docuwriter.ai/docuwriterai-platform-docs/connect-your-code/troubleshoot-repository-connections)
## Generate documentation

- [Generate complete codebase documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/generate-complete-codebase-documentation)
- [Choose your documentation audience](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/choose-your-documentation-audience)
- [Review and customize the outline](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/review-and-customize-the-outline)
- [Apply writing guidelines and templates](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/apply-writing-guidelines-and-templates)
- [Find and fill documentation gaps](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/find-and-fill-documentation-gaps)
## Generate documentation / Focused generators

- [Use focused generators](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/use-focused-generators)
- [Generate a per-file reference](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-a-per-file-reference)
- [Generate a README](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-a-readme)
- [Generate release notes from a branch comparison](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/generate-release-notes-from-a-branch-comparison)
- [Write a focused guide from selected source files](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/focused-generators/write-a-focused-guide-from-selected-source-files)
## Generate documentation

- [Manage saved generations and versions](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/manage-saved-generations-and-versions)
- [Troubleshoot documentation generation](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/troubleshoot-documentation-generation)
## Manage and share Spaces

- [Organize pages and folders](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/organize-pages-and-folders)
- [Edit and review documentation pages](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/edit-and-review-documentation-pages)
- [Document an endpoint with an API block](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/document-an-endpoint-with-an-api-block)
- [Search documentation and ask questions](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/search-documentation-and-ask-questions)
- [Publish a public documentation Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/publish-a-public-documentation-space)
- [Export and download documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/export-and-download-documentation)
- [Copy pages into AI tools](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/copy-pages-into-ai-tools)
## Keep documentation current

- [How Autopilot keeps documentation current](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/how-autopilot-keeps-documentation-current)
- [Connect a Space to Autopilot](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/connect-a-space-to-autopilot)
- [Choose branches, triggers and path filters](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/choose-branches-triggers-and-path-filters)
- [Review and apply documentation suggestions](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/review-and-apply-documentation-suggestions)
- [Configure optional auto-apply](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/configure-optional-auto-apply)
- [Configure Autopilot notifications](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/configure-autopilot-notifications)
- [Review activity and audit history](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/review-activity-and-audit-history)
- [Troubleshoot missing Autopilot updates](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/troubleshoot-missing-autopilot-updates)
## Integrations and AI assistants / MCP assistants

- [Connect an AI assistant to DocuWriter](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-an-ai-assistant-to-docuwriter)
- [Connect ChatGPT or Codex](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-chatgpt-or-codex)
- [Connect Claude Code](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-claude-code)
- [Connect Cursor](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-cursor)
- [Connect VS Code](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/connect-vs-code)
- [MCP capabilities and task reference](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/mcp-assistants/mcp-capabilities-and-task-reference)
## Integrations and AI assistants / Platform Agent

- [Use the Platform Agent](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/use-the-platform-agent)
- [Practical Agent workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/practical-agent-workflows)
- [Review Agent actions and approvals](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/review-agent-actions-and-approvals)
- [Use DocuWriter in Slack](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/platform-agent/use-docuwriter-in-slack)
## Integrations and AI assistants / n8n

- [Connect n8n and run your first workflow](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/connect-n8n-and-run-your-first-workflow)
- [Build CI/CD, team, and code-quality workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/build-cicd-team-and-code-quality-workflows)
- [Prepare an n8n workflow template for sharing](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/n8n/prepare-an-n8n-workflow-template-for-sharing)
## Integrations and AI assistants

- [Export a Space to Confluence](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/export-a-space-to-confluence)
- [Receive outgoing DocuWriter webhooks](https://docs.docuwriter.ai/docuwriterai-platform-docs/integrations-and-ai-assistants/receive-outgoing-docuwriter-webhooks)
## Account and billing

- [Invite teammates and manage access](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/invite-teammates-and-manage-access)
- [Understand credits and usage](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/understand-credits-and-usage)
- [Manage your account and subscription](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/manage-your-account-and-subscription)
- [Get support and report a documentation problem](https://docs.docuwriter.ai/docuwriterai-platform-docs/account-and-billing/get-support-and-report-a-documentation-problem)
## API reference / Start with the API

- [Public API quickstart](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/public-api-quickstart)
- [Bearer authentication and token management](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/bearer-authentication-and-token-management)
- [Errors, limits and retry behavior](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/errors-limits-and-retry-behavior)
- [Get the authenticated user](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/get-the-authenticated-user)
- [Get account and credit information](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/start-with-the-api/get-account-and-credit-information)
## API reference / Spaces and documents

- [List Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/list-spaces)
- [Create a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/create-a-space)
- [List documents in a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/list-documents-in-a-space)
- [Read a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/read-a-document)
- [Create a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/create-a-document)
- [Update a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/update-a-document)
- [Delete a document](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/delete-a-document)
- [Export documents and Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/spaces-and-documents/export-documents-and-spaces)
## API reference / Search

- [Search a Space](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/search/search-a-space)
- [Search across accessible Spaces](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/search/search-across-accessible-spaces)
## API reference / Generations

- [List generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/list-generations)
- [Get a generation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/get-a-generation)
- [List and filter my generations](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/list-and-filter-my-generations)
- [Generate code documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-documentation)
- [Generate code tests](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-tests)
- [Generate code optimization](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-optimization)
- [Generate code comments](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-code-comments)
- [Generate a UML diagram](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-a-uml-diagram)
- [Convert code between languages](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/convert-code-between-languages)
- [Generate multi-file documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-multi-file-documentation)
- [Generate Swagger / OpenAPI documentation](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/generations/generate-swagger-openapi-documentation)
## API reference / Repositories

- [List connected repositories](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/repositories/list-connected-repositories)
## API reference / Webhooks

- [Manage webhook subscriptions](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/manage-webhook-subscriptions)
- [Verify webhook signatures](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/verify-webhook-signatures)
- [Webhook event payloads and delivery](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/webhooks/webhook-event-payloads-and-delivery)
## API reference / Autopilot

- [Read and review Autopilot suggestions](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/autopilot/read-and-review-autopilot-suggestions)
- [Manage Autopilot repository links](https://docs.docuwriter.ai/docuwriterai-platform-docs/api-reference/autopilot/manage-autopilot-repository-links)
## Previous guides

- [Capabilities](https://docs.docuwriter.ai/docuwriterai-platform-docs/previous-guides/capabilities)
- [N8N User Guide Team Workflows](https://docs.docuwriter.ai/docuwriterai-platform-docs/previous-guides/n8n-user-guide-team-workflows)
- [N8N User Guide Getting Started](https://docs.docuwriter.ai/docuwriterai-platform-docs/previous-guides/n8n-user-guide-getting-started)
- [N8N User Guide Code Quality](https://docs.docuwriter.ai/docuwriterai-platform-docs/previous-guides/n8n-user-guide-code-quality)