Skip to content
SpecifyDocs

Documentation automation

Connect GitHub

Connect a GitHub account and repositories to your workspace, and get approval for organization repositories.

Connect GitHub so Specify can read repository code and development history to create feature documents and architecture canvases. Repository access and automatic content updates are configured separately.

Connect GitHub

  1. Open GitHub under Tools → Connectors.
  2. Select Connect, then choose the account and repositories to allow on GitHub.
  3. Return to Specify and check the connection status and Agent access.

Repositories granted to the GitHub App are available to Specify. Add any repository you need to the app installation’s access scope.

Selecting the Mamma develop repository in the GitHub repository list
Choose a connected repository to start work grounded in actual code.

Organization repositories and access

Your organization may require administrator approval. After approval, return to Specify and connect again. If a repository is missing, update access in the GitHub app installation settings, then return to the conversation and ask the agent to check again.

Use Reconnect when authentication expires. A suspended GitHub installation or removed repository access also needs to be restored.

Create documents from code

Specify the repository in chat and request a document or canvas. Include the feature scope, audience, and branch to clarify what the agent should inspect. See Create documents and canvases.

Connect push updates

In a document or canvas, open Connections → Manage connections → Event connections and check the repository. A push to its default branch can directly update the linked content. To enable automatic updates for a repository used in chat, link it through this menu.

See Manage connections for triggers and conditions that stop updates.