Can I use GitHub models tab to create a chatbot for my documentation?

[oshi98]

Select Topic Area

Question

Body

Is it possible to use the GitHub models tab to integrate a chatbot for my documentation? The documentation folder is in a GitHub repository and hosted on GitHub Pages.

[Meherab003]

Yes, you can build a chatbot for your documentation, but GitHub's Models tab alone isn’t enough. Since GitHub Pages only supports static content, you’ll need to connect it to an external backend (like OpenAI, Hugging Face, or a custom API) that reads your docs and powers the chatbot. Tools like LangChain or LlamaIndex work great for this.

[dax-side]

Yes, you can use GitHub Models to create a chatbot for your documentation! Here are a few approaches:

Option 1: Direct API Integration

You can use the GitHub Models API directly in your documentation site:

// Example: Using GitHub Models API
const response = await fetch('https://models.inference.ai.azure.com/chat/completions', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${GITHUB_TOKEN}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'gpt-4o-mini',
    messages: [
      {
        role: 'system', 
        content: 'You are a helpful assistant for documentation...'
      },
      {
        role: 'user', 
        content: userQuestion
      }
    ]
  })
});

Option 2: GitHub Actions + Static Site

Set up a GitHub Action to:

1. Process your documentation
2. Create embeddings/search index
3. Deploy chatbot to GitHub Pages

Option 3: Third-party Integration

Use services like:

• Gitiles - specifically for GitHub-hosted docs
• Docsify with AI plugins
• GitBook with AI features

Next Steps

To give you more specific guidance, could you share:

• What documentation framework you're using (Jekyll, Hugo, plain HTML, etc.)?
• Whether you want real-time responses or pre-generated answers?
• Your preferred programming language for implementation?

Note: GitHub Models is currently in beta, so check the [latest documentation](https://docs.github.com/en/github-models) for current limitations and availability.

[edujbarrios]

Hello! the past few days, I had the need to integrate a chatbot with my documentation hosted on GitHub Pages as well. After some research, I discovered that Manifest can be used to manage all that backend logic easily.!