T
testing
Getting Started High-Level Configuration

Setting up your workspace correctly ensures your team has the right access, your billing is in order, and your platform is secure. This guide walks you through the core platform settings, including user management, authentication, and subscription plans.

User Roles & Permissions

Control who can view, edit, and manage your documentation workspace.

Plans & Billing

Manage your subscription, view pricing plans, and unlock premium features.

User Management and Authentication

Secure your documentation by configuring authentication methods and assigning the right roles to your team members. You can easily separate public-facing documentation from private, internal resources.

Setting up Authentication

Enforcing secure login practices is the first step to protecting your workspace.

  1. 1

    Navigate to Security Settings

    Go to Settings > Access Control & Security in your dashboard.

  2. 2

    Choose an Authentication Method

    Select your preferred method. You can enable standard email/password logins, or enforce Enterprise SSO (Single Sign-On) if you are on a premium plan.

  3. 3

    Save and Apply

    Click Save Configuration to apply the new login requirements across your workspace.

User Roles

Assigning the correct roles ensures that users only have access to the tools they need.

RolePermissionsBest For
AdminFull access to billing, security, architecture settings, and content.Workspace owners and IT administrators.
EditorCan access the visual editor, create, modify, and publish documentation.Technical writers and developers.
ViewerRead-only access to private documentation and data models.Internal staff and stakeholders.

Always grant the principle of least privilege. Only assign the Admin role to users who explicitly need to manage billing or core system architecture.

Plans and Billing

Keep track of your usage and unlock advanced capabilities by managing your billing settings.

To view your current plan and explore upgrades:

  1. Navigate to Settings > Plans & Billing.

  2. Review your current usage, including active users and storage limits.

  3. Browse the Pricing Plans and Features to see what is included in each tier.

  4. Click Upgrade Plan to access premium features.

Upgrading to a premium plan unlocks advanced access controls, custom domains, and extended data storage limits.

Workspace Configuration

Beyond access and billing, you can customize your documentation's appearance and behavior through your core configuration settings (often managed via your gitdocai.json file):

  • Theming: Define specific light and dark mode colors, accent colors, and set your primary typography (e.g., the Inter font family).

  • AI Assistant: Enable a floating AI assistant widget to help users instantly find answers within your docs.

  • Knowledge Base: Configure a Help Center experience with custom hero titles (like "How can we help?"), search placeholders, and popular article sections.

  • Versioning: Enable version selectors and position them in your navigation bar to manage multiple releases of your documentation seamlessly.

Initializing Documentation Projects

Once your workspace is configured, you can initialize new documentation projects. The platform supports multiple initialization workflows to suit your existing assets:

Initialization MethodDescription
Blank ScaffoldStart fresh with a default folder and file structure.
AI PromptGenerate a complete documentation outline and starting content using AI.
File ImportUpload existing markdown or text files directly into the workspace.
OpenAPI/SwaggerAutomatically generate API reference documentation from your API spec.
GitHub RepositorySync directly from an existing codebase to pull in your docs.
Preset TemplateUse pre-configured templates for standard project types.
Website ImportImport and convert an existing website into structured documentation.

Local Development

If you are working with the starter kit locally, you can preview your documentation changes before publishing:

  1. 1

    Install the CLI

    Install the CLI globally to preview changes locally.

    npm i -g mint
  2. 2

    Run the Development Server

    Run the following command at the root of your documentation (where your configuration file is located):

    mint dev

Troubleshooting: If the development environment isn't running, try running mint install to reinstall dependencies. If your page loads as a 404, make sure you are running the command in the exact folder containing your configuration file.

System Architecture Overview

Understanding how your configuration affects the platform can help you make better security and structural decisions. Here is a high-level view of how authentication, user roles, and data storage interact within the system:

flowchart TD
    A["User Request"] --> B{"Auth Gateway"}
    B -->|Valid Login| C["Role-Based Access Control"]
    B -->|Invalid| D["Access Denied"]
    C -->|Admin| E["Billing & Core Settings"]
    C -->|Editor| F["Visual Editor"]
    C -->|Viewer| G["Published Docs"]
    E --> H[("Data Models & Storage")]
    F --> H
    G --> H

Frequently Asked Questions

Can I mix public and private documentation?

Yes. You can configure access control at the project or folder level. This allows you to maintain a public knowledge base for your customers alongside private, internal developer documentation.

Where do I find my billing invoices?

All past invoices and payment histories can be downloaded from the Plans & Billing section under the Billing History tab.

How does the visual editor interact with my data models?

The visual editor connects directly to your underlying data models and storage architecture. Editors can seamlessly update content without needing to understand the raw technical storage layer.