Guides › Authentication
Authentication
Acme uses short-lived sessions. Create one with connect(), then attach the returned Session to every request.
docstube generates it from your codebase, fact-checks every claim against the source, writes it for the people actually reading it, and keeps it in sync as your code changes. Nothing to write. Nothing to maintain.
Step 1 of 3
You set it up in a wizard
Pick a doc type and who the docs are for.
Runs on the AI you already use
of developers call technical documentation their number-one way to learn a new tool. source
Code ships every day; hand-written docs don't move. Signatures drift until the page is quietly describing an API that no longer exists.
getSession() getSession(opts) Whoever wrote the code can't un-know it. The obvious step gets skipped, internal names leak in, and the context a newcomer actually needs never makes it onto the page.
Docs are the chore that loses to every deadline. The easy pages get done; configuration, edge cases, and the gnarly migration — the ones readers need most — stay empty.
Point a model at your repo and the pages read beautifully. Check them against the source and the problems pour out — fluent, confident, and wrong.
From a single command to a site you own — and back in sync on every commit. Here's the whole loop, start to finish.
Run npx docstube wizard
and a localhost UI opens. Pick a doc type, name your readers, add any context that lives only in your
head. docstube proposes the full page plan — edit it like a list, hit generate, and you're done. That's
the entire job.
Doc type
Reader personas
Information architecture
drag to reorderdocstube builds a structural map of your codebase first — every module, export, type, and call site. A writer agent then drafts each page grounded in the actual symbols it documents, not a vague impression of them. Finished pages stream into a live preview as the run advances; nothing hides in a black box.
Every persona you named gets its own reviewer agent. The new-integrator reviewer demands a clean five-minute path that assumes nothing; the platform-engineer reviewer pushes for depth, edge cases, and configuration. Their notes go straight back to the writer — so pages are aimed at your actual readers, not a blurred-together average.
AI reviewers · per persona
five-minute path is clear — nothing left unexplained
wants the token-refresh edge case spelled out
Reading well isn't the same as being right. Deterministic verifiers run real tooling —
tsc and
pyright type-check
every sample; imports, links, and diagrams must resolve; every API reference must match your compiler.
Then AI verifiers catch what no tool can: unbacked claims, quiet contradictions, examples that don't do
what the prose says.
Anything that can't be proven ships flagged for review, never silently wrong — with the exact finding attached.
Deterministic verifiers · real tools
AI verifiers · judgment
docstube hashes your code at the symbol level and remembers which pages each symbol feeds. Change one
function and docstube refresh
regenerates only the pages that depend on it — a sliver of the cost of a full rebuild. Run it locally, or
let the GitHub Action open a PR on every push with the changes and the reasons behind them.
docstube refine circles back to improve your weakest pages first.Changed symbols detected
getSession() refreshToken() AuthError Tokens this refresh
~11kvs ~294k to regenerate all 49 pages
yourproject.dev › docs › auth
Authentication — Acme docs
Create a session and attach it to every request. Sessions expire after 60 minutes…
Call acme.connect() to authenticate, then reuse the session.
OSS maintainers · API companies
A site that markets your project while it teaches it — and that every channel can find.
Adoption follows good docs. Developers commit to the tool they can learn fastest. A clear, searchable site is how you become that tool.
Found by people and their AI. SEO, AEO, and an llms.txt out of the box — so search engines, answer engines, and coding agents all cite your real API.
Correct, not just fluent. Every sample is type-checked and every reference matches your compiler, so the code a reader copies actually runs.
Auth service
matches mainSessions are minted in auth.ts and refreshed by the gateway.
engineering teams
The private reference for a codebase that changes faster than anyone can document by hand.
Onboarding that keeps up. New hires ramp on docs that match main — not a wiki that went stale three sprints ago.
Answers without the interruption. Instant search over always-current pages, so nobody pings the one engineer who still remembers how it works.
Context your agents can trust. Ships an llms.txt and an MCP server, so the coding agents on your team read accurate internals instead of guessing.
Instant search, rendered diagrams, type-checked samples, API references, light and dark — everything a great docs site needs, and you wrote none of it.
Guides › Authentication
Acme uses short-lived sessions. Create one with connect(), then attach the returned Session to every request.
No plugins to wire up, no theme to fork. The components come with it.
Full-text search across every page in milliseconds, powered by Pagefind.
Architecture and flow diagrams, rendered and syntax-checked. Sketch mode by default.
Every sample runs through tsc or pyright, so the code on the page actually compiles.
Create a session, then attach it to every request you make.
Define a term once; it links consistently everywhere it appears.
getSession(opts)
Signatures extracted straight from your compiler with TypeDoc and griffe.
Drop real product screenshots — like a console dashboard — into a page with one component.
The rich MDX building blocks a great guide is actually made of.
Both themes ship together; every reader picks the one they prefer.
llms.txt, llms-full.txt, and a docs-serving MCP server, included by default.
Review the rendered site, point at whatever's off — a word, a paragraph, a whole page — and say what you'd change in plain English. docstube makes the fix, then remembers the rule, so you never give the same note twice.
Acme uses short-lived sessions to authorize requests. Each session is a bearer token you attach to every call.
Initialise the client with your workspace token to begin.
A word, a paragraph, a code block, a section, or the whole page. Click it on the rendered site and describe the change like you'd tell a teammate — no editor, no MDX, no tickets.
Your note becomes a durable writing rule, committed alongside your config. Every regeneration from here on respects it — you never give the same feedback twice.
One note doesn't fix one spot. docstube finds the same issue across the rest of your docs and corrects it too — then re-verifies the lot.
Every tool here can generate or host docs. Only one mechanically checks that what it wrote is actually true — and flags the rest instead of shipping it wrong.
| Capability | | Hosted platforms Mintlify, GitBook | AI doc generators DeepWiki-style | Coding agent + you DIY |
|---|---|---|---|---|
| Open source | MIT | Closed | Mostly closed | n/a |
| Generates from your code | Yes | AI add-on | Yes | Yes |
| Mechanically verifies every claim | Every claim | None | None | By hand |
| Runs on your own AI | Any provider | Metered credits | Their models | Yes |
| Incremental, symbol-level updates | Symbol-level | File scan | Re-crawls | Manual |
| You own the output | MDX / Astro | Their platform | Varies | Markdown |
Call acme.connect(token) to get a Session, then attach it to every request. Sessions expire after 60 minutes — refresh before they do.
without your docs: it guesses from a two-year-old blog post
Every site ships a compact and a full machine index, so agents read accurate, current context instead of guessing.
Point Claude, Codex, or any MCP client at your docs and let it answer from verified pages - not a stale crawl.
References are pulled from real signatures via TypeDoc and griffe, so the types agents read match the types you ship.
Every feature, MIT-licensed, forever. You pay only your own AI provider, at their prices, with spend caps you set. Paid tiers come later — and they'll sell what a single repo can't have, never the product itself.
Not a free tier of something bigger. The entire product, MIT-licensed.
Join the waitlistLater, for teams — on the roadmap, not for sale yet
For teams with many repos: a cross-repo Ask agent, docs-health across your fleet, SSO and audit. Sells what a single repo can’t have — never the core product.
Everything in Cloud, self-hosted on your infrastructure, with an SLA and hands-on support.
We never mark up tokens. You bring your own Claude, Codex, Gemini, or any API key — and pay that provider directly, exactly like your normal usage.
docstube is launching soon. Join the waitlist and we’ll send you a single email the day it’s ready — nothing else.
docstube is launching soon. Drop your email and we'll send you a single message the day it's ready.
Thanks for signing up — we'll email you the day docstube is ready.