Learn How to Use VibeAIHub

Difficulty Level

• Beginner: Includes glossaries, analogies, and step-by-step explanations
• Intermediate: Assumes coding knowledge, focuses on patterns and architecture
• Advanced: Deep dive into trade-offs, design decisions, and optimization

Output Language

Generate documentation in:

Export Formats

• PDF: Formatted documents with syntax highlighting
• Markdown: Compatible with GitHub, Docusaurus, MkDocs
• EPUB: E-reader format for Kindle, Apple Books

Advanced Settings

• Exclude Patterns: Ignore specific files or directories
• Custom Tone: Casual vs. formal documentation style
• Chapter Depth: Control detail level per section

Choose the Right Difficulty

Beginner mode adds explanations and analogies. Advanced mode focuses on architecture and trade-offs.

Use Incremental Updates

After updating your repo, regenerate only changed chapters to save time and maintain edits.

Customize Your Output

Adjust tone, formatting, and which directories to include for documentation that matches your style.

Leverage CI/CD Integration

Set up GitHub Actions to automatically update documentation on every push.

Generation takes longer than expected

Large repositories (10K+ files) may take up to 10 minutes. Monorepos with multiple packages require additional processing time.

Some files are not included

By default, we exclude test files, node_modules, and generated files. You can customize these exclusions in settings.

Private repository access denied

Ensure you've connected your GitHub account with appropriate permissions. Re-authorize if you've changed repository visibility.

Export formatting issues

PDF exports may have minor formatting differences from the online preview. Try Markdown export for full control over formatting.

What types of repositories work best?

VibeAIHub works with any codebase, but is most effective for well-structured projects with clear module organization. Web applications, libraries, and frameworks with 1K-100K files are ideal.

Can I exclude specific files or directories?

Yes! In the configuration step, you can specify exclude patterns (e.g., *.test.js, internal/, secrets/). These patterns use standard .gitignore syntax.

How does the AI understand my code?

Our AI analyzes your code structure, imports, dependencies, and patterns. It doesn't just read comments—it understands relationships between modules, design patterns, and architecture.

Is my source code stored or shared?

Never. Your code is processed in isolated environments and deleted immediately after generation. We are SOC 2 compliant and never share your code.

Can I edit the generated documentation?

Absolutely. After generation, you can edit chapters online before exporting. For Pro and Team plans, incremental updates preserve your manual edits.

What's the difference between difficulty levels?

Beginner adds glossaries and analogies. Intermediate assumes coding knowledge. Advanced focuses on architecture, trade-offs, and design decisions.

Can I generate documentation in other languages?

Yes! We support documentation generation in English, Chinese, Japanese, Korean, Spanish, and more. Select your output language during configuration.

What happens if my repository has license issues?

You are responsible for ensuring you have the right to process any repository. Generated documentation may include code excerpts subject to the original license.

How do I set up CI/CD integration?

We provide a GitHub Action that can be added to your workflow. It connects to your VibeAIHub account and regenerates documentation automatically on pushes to main branch.

Can I use VibeAIHub for commercial projects?

Yes! Generated documentation is yours to use, modify, and distribute as you see fit. Pro and Team plans include commercial usage rights.

What export formats are available?

We support PDF (formatted documents), Markdown (compatible with GitHub, GitLab, Docusaurus), and EPUB (e-readers). Notion import is coming soon.