Quickstart
From zero to a live, AI-powered documentation site. No configuration files. No deployment pipeline. Five steps.
Create your account
Go to algoquill.ai/signup and create a free account. No credit card required. You get 1 project and up to 5 pages on the free tier.
Create a project
After signing in you land on the dashboard. Click New Project. Give it a name — this becomes your subdomain. A project named my-api gets the URL my-api.algoquill.ai.
- Lowercase letters, numbers, hyphens
- 3–50 characters
- No spaces or special characters
Connect your GitHub repository
In your project dashboard, go to RAG Docs → Sync. Paste your GitHub repository URL and click Sync Repository.
AlgoQuill reads your codebase, README, and configuration files. It chunks and indexes the content into a searchable knowledge base. This takes 30–120 seconds depending on repo size.
repo scope.Generate your first documentation page
Once the sync completes (you'll see a chunk count), go to RAG Docs → Generate. Fill in:
Who is this for?Pick your audience: Developers, Customers, Enterprise, or Recruiters. This completely changes the tone and structure.TopicWhat to document. Example: "Authentication API", "Getting started with the SDK", "Database schema".TypeAPI Reference, Quickstart, Tutorial, or Reference guide.Click Generate Documentation. AlgoQuill searches your indexed code for relevant context, sends it to Claude with a structured prompt, and returns a complete documentation page in 10–30 seconds.
Review and publish
Generated content appears in a preview below. Read through it — the AI does a good job but you know your product better. Click Save as Page to add it to your project. It saves as a draft.
Go to Pages in the sidebar. Find your new page and click the edit icon to open the editor. Make any changes, then toggle the status from DRAFT to PUBLISHED.
yourproject.algoquill.ai to see the published page. Share this link anywhere.