< back_to_blog
|5 min

> Publish Your Docs for Free

Connect a repo, get a generated doc site, and publish it at a public URL — without paying a cent. Here's everything Code Summary does, end to end.

CST

code_summary team

// author

#product#documentation#hosting

Most documentation tools ask you to do the documentation. They give you a nice editor, a theme, a deploy button — and then leave the actual writing to you. That's the hard part, and it's the part that never gets done.

Code Summary works the other way around. You connect a repo, and the docs get written. You review them, you publish them, and they live at a public URL. The free plan does all of that — no credit card, no trial countdown.

This post walks the whole thing, start to finish, so you know exactly what you get.

## Step one: connect your code

There are two ways in.

Install the GitHub App. Point it at the repos you want documented. From then on, every push to your default branch can trigger a fresh generation. Your docs track your code instead of rotting behind it.

Or upload a zip. No integration, no permissions to grant. Drop an archive of your codebase and you get a one-shot generation. Good for private code, quick evaluations, or repos that don't live on GitHub.

Either path lands you in the same place: a clone of your code, read end to end by a premium model, turned into a structured doc tree.

## Step two: the docs get generated

This is the part other tools don't do for you.

Code Summary reads the actual code — not just the README, the whole thing — and produces a versioned documentation set: an architecture overview, API references, component and module breakdowns, setup guides, and AI-agent context files. It's organized, cross-linked, and written to be read by a human who has never seen the codebase before.

Generation isn't a black box you have to accept wholesale. You get a live view of it happening — cloning, planning, generating, finishing — so you're never staring at a spinner wondering if anything is occurring.

> tip

Generation is incremental. When you push changes, Code Summary updates the affected docs rather than regenerating everything from scratch — and it won't quietly overwrite sections you've edited by hand.

## Step three: review and edit

Generated docs are a starting point, not gospel. You can edit any page directly in the dashboard with a real editor. Fix a wrong assumption, add the context only you have, tighten the wording.

If a later generation wants to change a page you've already edited, that change doesn't just land. It goes into a review queue. You decide what gets accepted. Your hand-written prose is protected from the robot's enthusiasm.

## Step four: bundle repos into a product

A single repo's docs are useful. But most real products aren't a single repo.

A product in Code Summary is a customer-facing doc base synthesized from one or more repos. Your API lives in one repo, your web app in another, your worker in a third — a product stitches them into one coherent docs site that reads like it was written as a whole, because it was.

Pick an archetype when you create one and the output shapes itself accordingly:

  • >Product guides — end-user how-tos for a SaaS app
  • >API reference — endpoints, auth, request and response shapes
  • >Full SaaS — guides and API reference under one roof
  • >Marketing site — positioning, no tradecraft

The free plan includes products. You can run two of them before you'd need to upgrade.

## Step five: brand it

Before you publish, make it yours. Set a logo for light and dark mode, an accent color that runs through links, headings, and the active nav, a header call-to-action button, even custom CSS if you want to go further.

There's a live preview that flips between light and dark so you see exactly what a visitor sees before anything goes public.

## Step six: choose who can see it

Visibility is a deliberate choice, not a default you discover later:

  • >Public — anyone with the URL, indexed by search engines
  • >Unlisted — anyone with the URL, but not indexed
  • >Private — authorized access only

Nothing goes live until you say so. Generation produces a draft; you click publish on the version you want. Old versions stay around, so a rollback is one click, not an archaeology project.

## Step seven: publish — for free

This is the line other tools draw at the paywall. We don't.

On the free plan you publish a public doc site at a real URL and share it with anyone. Your customers, your users, your open-source community — they read your docs at a clean address, with your branding, kept current by your pushes.

That's the whole core loop, and it costs nothing.

## Where the paid line actually is

We're not going to pretend everything is free. Here's the honest split.

Free gets you: unlimited repos, up to two products, automatic generation, the editor and review queue, public hosting with your branding, and an MCP endpoint on the shared domain.

Pro and Team add the things that matter once you're past evaluating: unlimited products, your docs on your own domain with automatic SSL, private docs and token-gated access, a premium generation tier, and a much larger monthly credit pool.

The point of the free tier isn't a crippled demo. It's a real, publishable, branded doc site. You upgrade when you outgrow it, not to unlock the basics.

## One more thing: your docs are also a tool

Every doc site you publish is queryable by AI agents over MCP — the same docs, available to a coding assistant as a live source instead of a stale copy. That's a big enough idea to deserve its own post, and it has one: Your Docs, as an MCP Server.

## Start

Connect a repo, watch the docs generate, publish the site. The free plan takes you all the way through that without asking for a card.

Get started — your first published doc site is a few minutes away.