Configure various project settings, including custom domains, generation parameters, and appearance.
AI Docs provides robust project management features, allowing you to configure settings, customize the appearance of your generated documentation, and manage the lifecycle of your projects. This guide details how to access and utilize these settings to tailor your documentation sites to your specific needs and brand.
To manage a project's settings and customizations, navigate to the individual project page within your AI Docs dashboard. You can do this by clicking on a project from the Project Grid on your main dashboard or by directly accessing its URL. This page serves as the central hub for all project-specific configurations and actions.
Upon entering a project's page, you'll find a compact information bar and a series of tabs. The information bar provides a quick overview:
repoOwner/repoName of your connected GitHub repository.You can modify core settings for your project, such as its subdomain and custom domain. These settings are managed through the AI Docs dashboard interface.
Every AI Docs project is initially assigned a unique subdomain (e.g., your-project.aidocs.com). You have the flexibility to change this subdomain to something more descriptive or aligned with your project's identity.
For a more professional and branded presence, you can configure a custom domain for your documentation site (e.g., docs.yourcompany.com).
Custom domain functionality is an exclusive feature for users on a Subscription Plans that includes it. If your current plan does not support custom domains, you will be prompted to upgrade. Refer to Managing Your Subscription for details on upgrading your plan.
Once configured, AI Docs handles the necessary DNS routing to serve your documentation from your chosen custom domain.
AI Docs allows you to customize the appearance of your generated documentation site to align with your brand.
Each documentation project can have its own distinct favicon and Apple touch icon. This allows you to brand each documentation site independently from the main AI Docs application.
your-project.aidocs.com or docs.yourcompany.com.The overall look and feel of your documentation site can be customized to match your brand's aesthetic. This includes:
For comprehensive guidance on modifying the UI, including detailed instructions on styling, theming, and typography, refer to the UI Customization page.
Key project information, such as the project name and links to its GitHub repository, are displayed prominently in the documentation UI. These elements are sourced directly from your project's settings and help maintain your brand's presence within the generated documentation.
Beyond settings, you can perform critical actions on your projects directly from the project page.
The "Regenerate" button allows you to manually trigger a full documentation regeneration for your project. This is useful if you've made significant changes to your GitHub repository and want to ensure your documentation reflects the latest codebase immediately, without waiting for an automated webhook trigger.
The "Regenerate" button will be disabled if your project is currently in an "ingesting" or "pending" status, indicating that a generation process is already underway. You can monitor the progress in the Monitoring Project Activity tab.
You can permanently delete a project from AI Docs. This action is irreversible and performs several cleanup steps:
Deleting a project is a permanent action and cannot be undone. Ensure you have backed up any custom content or configurations if needed before proceeding.
Your AI Docs subscription plan dictates certain limits and available features for your projects.
If your subscription plan has a limit on the number of active projects (e.g., the "free" plan), and you exceed this limit, you will encounter a paywall when attempting to access or create additional projects. This paywall will prompt you to upgrade your subscription to continue. Refer to Subscription Plans for an overview of available plans and their limits.
As mentioned, the ability to use custom domains for your documentation sites is tied to specific subscription plans. Ensure your plan includes this feature if you intend to use your own domain.