AI Documentation for React Projects
Hosted docs for React repos. Auto-generated, auto-updated nightly. Detects components, hooks, and project structure.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
package.json (react dependency)src/App.tsxvite.config.tssrc/components/
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Installation and setup
Available scripts
Component overview
Styling approach
Testing with React Testing Library
Frequently asked questions
Does it understand custom hooks?
Yes. ReadmeBot identifies custom hooks in your codebase and documents their purpose and usage patterns in the README.
Will it detect my state management solution?
ReadmeBot recognises Redux, Zustand, Jotai, Recoil, and React Context patterns and documents them in the architecture section.
Does it work with Vite and Create React App?
Both are fully supported. ReadmeBot detects your build tool and generates the correct development and build commands.