ShipDocsShipDocs home
Import my repo now

ShipDocs Docs

Agent-readable product documentation for ShipDocs. Every page here has an HTML route and a Markdown twin.

ShipDocs turns any codebase into searchable, chat-ready documentation. Connect a GitHub or GitLab repo, upload a zip, or push from the CLI. ShipDocs scans the tree, detects components, generates an Overview plus per-component Markdown docs, and grounds AI chat in those docs (answers cite file paths).

Site: https://shipdocs.sh
Machine index: https://shipdocs.sh/llms.txt
Changelog: https://shipdocs.sh/changelog.md

Contents

PageHTMLMarkdown
How ShipDocs works/docs/how-it-works/docs/how-it-works.md
CLI / getting started/docs/cli/docs/cli.md
Security & encryption/docs/security/docs/security.md
Free tools overview/docs/free-tools/docs/free-tools.md

Quick facts

  • Private and public repos — GitHub, GitLab, ZIP upload, or CLI. Bitbucket coming soon.
  • Encryption — AES-256-GCM at rest with per-project keys (envelope encryption). See Security.
  • No AI training on your code — zero-retention model API endpoints. Binding product commitment.
  • Free tier — 2 repos, structured docs, limited AI chat. No credit card required.
  • Free public tools — no signup; operate on public repo URLs. See Free tools.

How do I get started with ShipDocs?

Import a GitHub, GitLab, or Bitbucket repository (or upload a ZIP). ShipDocs indexes it, plans one documentation page per module, and writes the first pages in about two minutes. The pipeline walkthrough and the CLI reference cover the details.

Is my source code private and encrypted?

Yes. Source files and generated docs are encrypted at rest with AES-256-GCM using a per-project key wrapped by a KMS-backed master key, and inference runs on zero-retention endpoints: your code is not used to train models. Security and encryption lists the exact guarantees.

Can an AI agent read these docs?

Every page has a Markdown twin at the same URL plus .md, the site publishes llms.txt and llms-full.txt, and projects can expose an MCP endpoint that serves your own generated documentation to Cursor and Claude.