GitHub Repository Synchronization

Summary: The GitHub Synchronization feature empowers developers to transform technical documentation into an AI-powered knowledge base. By connecting repositories to Antimanual, your chatbot automatically stays updated with the latest project information, documentation, and setup guides.

The GitHub Synchronization feature helps developers turn their technical documents into an AI-powered knowledge base. By connecting your GitHub account to Antimanual, you can sync your README files and markdown guides directly to your AI chatbot. This removes the need for manual updates and ensures your AI always has the latest project information.

What is GitHub Synchronization?

Many teams keep their best documentation in GitHub. Antimanual allows your AI to read these files to answer questions about your project. It is perfect for providing instant support for:

• API endpoints and usage.
• Installation and setup guides.
• Technical architecture overviews.

Before you begin, make sure your data source settings are configured to allow AI processing.

How to Sync Your Repository

Follow these three simple steps in your Antimanual dashboard:

1. Connect your account: Log in to your GitHub account through the plugin settings to give it access to your files.
2. Select a project: Choose the public or private repositories you want the AI to read.
3. Start the sync: The AI will automatically scan your selected repositories for documentation.

How the AI Reads Your Files

Antimanual is designed to focus on your documentation. Here is how it processes your data:

• Focuses on markdown: It prioritizes .md and .mdx files to ensure the AI reads clear documentation instead of complex code.
• Cleans the content: It removes extra code and formatting to keep only the important information.
• Prepares for AI: It converts your text into a format the AI can easily understand and search.

Tips for Better AI Results

To get the most accurate answers from your AI, organize your repository with these tips:

• Write a strong README: Keep a clear, detailed README.md file in your root folder.
• Use a docs folder: Store your specific guides in a dedicated /docs folder.
• Use clear headings: Use standard H1, H2, and H3 headers to help the AI understand your document structure.

Frequently Asked Questions