This guide covers every feature in AlgoQuill and how to use them effectively.

Dashboard Overview

Your dashboard is the central hub for managing documentation projects. From here you can create new projects, view analytics, and manage your team.

Block Editor

The block editor is how you create documentation pages. It supports 15+ block types:

• Paragraph - Regular text content
• Headings - H1, H2, H3 for structure
• Code Block - Syntax-highlighted code with language selection
• Callouts - Note, Warning, Tip boxes for important information
• Lists - Bullet and numbered lists
• Images - Upload or link to images
• Tables - Data tables with headers
• Dividers - Horizontal separators
• API Endpoint - Formatted API documentation blocks

Tip: Type / at the start of any line to see the slash command menu.

AI Generate

The AI Generate feature creates entire documentation suites from your codebase:

1. Connect your GitHub repository in project settings
2. Click "AI Generate" in the Pages section
3. Choose what to generate (Quickstart, API Reference, etc.)
4. AI analyzes your code and creates documentation

AI Chat Assistant

The AI Chat appears on your published docs and helps visitors find answers:

• Understands your documentation content
• Answers questions in natural language
• Cites sources from your pages
• Available on Starter plan and above

Configure AI Chat in Project → Configure → AI Chat.

Analytics

Track how people use your documentation:

• Page Views - See which pages are most popular
• Visitors - Unique visitor counts
• AI Queries - What questions people ask the AI
• Feedback - Page ratings and comments

Export analytics data via SEO & Dev Tools → Analytics Export.

Custom Domains

Connect your own domain to your documentation:

1. Go to Configure → Custom Domains
2. Enter your domain (e.g., docs.yourcompany.com)
3. Add the DNS records shown to your domain registrar
4. Wait for DNS propagation (5-60 minutes)
5. Click "Verify" to confirm setup

URL Redirects

Redirects ensure old links still work when you move or rename pages:

• Go to Configure → Redirects
• Enter the old path (e.g., /old-page)
• Enter the new path (e.g., /new-page)
• Choose permanent (301) or temporary (302)

When to use: Whenever you rename a page slug, delete a page, or reorganize your docs.

SEO & Developer Tools

These files are automatically generated for search engines and AI tools:

You don't need to do anything with these files. They're automatically discovered by search engines and AI tools when your docs are live.

Team Members

Invite team members to collaborate on documentation:

• Go to Workspace → Team
• Enter email addresses to invite
• Assign roles (Admin, Editor, Viewer)

Team member limits depend on your plan (1 for Free, 3 for Starter, 10 for Pro).

Billing & Plans

Manage your subscription in Workspace → Billing:

• View current plan and usage
• Upgrade or downgrade plans
• Update payment method
• View invoices

See our Pricing page for plan details.

Preview Mode

Preview how your documentation will look to visitors:

• Click the "Preview" button in the sidebar
• See the full documentation site with navigation
• Test the AI chat assistant
• Check mobile responsiveness

Changelog

Keep users informed about updates:

• Go to Changelog in the sidebar
• Create entries with version numbers
• Categorize as Feature, Fix, or Improvement
• Changelog appears in your published docs

GitHub Sync (RAG)

Connect your repository for AI-powered documentation:

1. Go to Configure → GitHub Sync
2. Enter your repository URL
3. Add a GitHub token (for private repos)
4. Click "Sync Repository"

Once synced, AI Generate and AI Chat can understand your codebase.