Skip to main content

Admin Tasks

Instructions for System Administrators to configure, manage, and secure the SudoDocs workspace.

The Admin Dashboard's tabs, in the order they appear:

  • Overview: How much of SudoDocs is set up, the next step, seats and AI credits, and repository health. Opens first.
  • Provider: Bring your own key for text generation and/or embeddings & search (OpenAI, Claude, DeepSeek, Voyage AI, or a custom endpoint) instead of the platform Gemini key.
  • Repositories: Connect GitHub repositories (with Connect with GitHub or a token) and public websites, and sync them.
  • Knowledge Base: Configure the knowledge base and style guide SudoDocs writes to.
  • API Specs: Set where your OpenAPI spec lives and which style rules check it.
  • Doc Team Roles (Roles tab): Customize what the Information Architect, Technical Writer, and Editor each prioritize and check for, with sample instructions.
  • Connect Services (Services tab): Connect Jira and Slack to SudoDocs.
  • Security & SSO (SSO tab): Set up Single Sign-On for accessing SudoDocs.
  • Users: Invite and remove members, assign roles, manage members' sign-in and two-factor, and set the organization's sign-in policy.
  • Organization: Manage your subscription and API keys, or delete the organization.

Also for administrators:

Your own password and two-factor settings are on Profile & security, not in the Admin Dashboard.

Every task above - and most User Tasks too - has a scriptable equivalent for Enterprise organizations: see the CLI Guide to automate them from the command line or CI/CD pipelines instead of the dashboard.