Generate Documentation for Your Monorepo
Create structured documentation for monorepo projects that explains workspace organisation, packages, and development workflows.
Free for public repos. No account needed.
Workspace overview
ReadmeBot detects workspace configurations (npm workspaces, Turborepo, Nx, Cargo workspaces, Go modules) and generates an overview of all packages with their purposes.
Package documentation
Each package or app in your monorepo gets documented with its dependencies, scripts, and relationship to other packages.
Development workflow
ReadmeBot documents shared scripts, build pipelines, and the correct order for running tasks across packages.
Frequently asked questions
Does it detect Turborepo?
Yes. ReadmeBot reads turbo.json for pipeline configuration and documents task dependencies and caching behaviour.
Will it document all packages?
ReadmeBot lists all packages in the workspace with their names, descriptions, and inter-package dependencies.
Does it handle Nx workspaces?
Yes. ReadmeBot understands Nx project configurations and generates documentation matching your workspace structure.