Everything you need to know

How do I connect my first repo?

Sign in with GitHub, click "+ Add repository" on the dashboard, and enter your repo in owner/repo format (e.g. acme/my-app). DocForMe will immediately start a sync. Your first doc pages will be ready in under 60 seconds.

What permissions does DocForMe need?

Read-only access to your repository contents and commit history. We never write to your repo, open pull requests, or push anything. You can revoke access at any time via GitHub → Settings → Applications.

Which languages and frameworks are supported?

DocForMe reads any text-based repository. It works especially well with JavaScript, TypeScript, Python, Go, Rust, and Ruby projects. Frameworks like Next.js, Express, Django, and Rails are recognised automatically.

How often does DocForMe sync?

Free plan: once per day per project. Pro plan: up to 3 times per day across all your projects. You can also trigger a manual sync at any time from the project page.

What happens during a sync?

DocForMe compares your latest commit SHA against the last sync. If nothing changed, the sync is skipped instantly at no cost. If there are new commits, it runs up to 4 passes: overview, briefing + what changed, codebase map (only if files were added or removed), and a full breakdown.

Why did my sync say "nothing changed"?

If your latest commit SHA matches the last synced commit, DocForMe skips all AI passes. This keeps costs low and the process fast. Push a new commit and sync again to get fresh docs.

How many syncs do I have left?

The dashboard header and each project page show your remaining syncs. Free plan shows 0/1 per project (resets daily). Pro shows a user-level counter that resets at midnight UTC.

What is the briefing page?

The briefing is the most important page. It tells you exactly where you left off, what changed in the last sync, any TODOs or unfinished items found, and the current state of the project. Designed to be read in 30 seconds.

What is the codebase map?

A structured overview of your repo's architecture: top-level directories, API routes, data models, key components, and how they connect. It's regenerated whenever files are added or removed.

What does "looks unfinished" flag?

DocForMe scans for TODO and FIXME comments, placeholder text, empty function bodies, disconnected routes (routes that are defined but never called), and missing error handling. It lists them by file with line numbers.

What is the breakdown page?

A file-by-file explanation of every meaningful file in your project: what it does, what it exports, and how it fits into the wider codebase. Updated on every sync.

What does the free plan include?

1 connected repository, all core doc pages, and 1 sync per day. No credit card required to start.

What does Pro include?

Unlimited repositories, all 11 doc pages, up to 3 syncs per day across your projects, the visual codebase map, the unfinished detector, and shareable public links. $9/month or $6/month billed annually.

How do I upgrade or cancel?

Go to Settings → Billing and click "Manage". This opens the Stripe billing portal where you can upgrade, downgrade, or cancel. Changes take effect immediately.

Can I share my project docs?

Yes. Pro plan users can generate a public shareable link for any project. The link shows a read-only version of the overview and briefing. You can disable it at any time from the project settings.

Can anyone see my private repo content?

No. Shareable links only expose the generated documentation (plain English summaries), never raw source code. Your actual code never leaves our server during generation.