Skip to main content

Guides Integration Settings

Menu Path: Workspace > Settings > Appearance > Guides

Permission Requirements

To configure Guides settings, you must have the Workspace:Settings:Manage permission.

The Guides configuration page allows you to link your workspace to a GitHub repository where your contextual in-panel guides are hosted. By connecting a repository, the system automatically syncs your Markdown (.md) files and displays them inside the slide-over Right Toolbar for contextual Help and API documentation.

Key Features & Configuration​

1. GitHub Integration Prerequisite​

  • Connection Check: This module requires an active GitHub integration. If GitHub is not connected, the system will display an alert prompting you to navigate to the Integrations page to authenticate the app.

2. Repository Configuration​

Once GitHub is connected, you can configure your in-app guides repository:

  • Repository Name: Enter the full name of your target repository (e.g., AVCI-CMS/in-app-guides for the official guides, or your custom fork your-org/custom-guides).
  • Branch: Specify which branch to pull the documentation from (e.g., main). This allows you to draft changes on a separate branch and publish them by merging into main.
Official In-App Guides Repository

AVCI CMS provides a ready-to-use, comprehensive repository containing contextual API references and operational guides for all platform modules:
👉 https://github.com/AVCI-CMS/in-app-guides
For more information on how the drawer operates, see In-App Contextual Guides.

[!TIP] Workflow Suggestion: Use a drafts or staging branch for writing and reviewing internal SOPs. Once approved, merge it into your main branch. Since your workspace syncs with main, the updates will appear in the Right Toolbar automatically without touching the backend settings again.

Common Issues​

  • Issue: Documentation updates pushed to GitHub are not appearing in the Right Toolbar.
  • Solution: Verify that the "Branch" configured here matches the branch you pushed your changes to. Also, check the Integrations page to ensure your GitHub access token is active and valid.