Bootstrap Docs
Bootstrap Documentation
Bootstrap Documentation allows Docify to generate initial documentation for an existing codebase in a single, controlled pull request.
This feature is designed for projects that already have public APIs or components but lack consistent documentation.
What Bootstrap Does
When triggered, Docify:
- Scans the repository for public-facing code
- Identifies exported APIs, components, and configuration interfaces
- Generates structured documentation files following your existing docs framework
- Opens one pull request containing all generated documentation
No changes are merged automatically.
When to Use Bootstrap
Bootstrap is useful when:
- Introducing Docify to an existing project
- Onboarding new contributors
- Preparing a repository for open-source or public use
- Establishing a baseline for long-term documentation maintenance
After bootstrap, Docify switches back to incremental updates only.
Safeguards & Limits
Bootstrap includes multiple safety controls:
Controlled Scope
- A hard limit on the number of files generated per run
- Large repositories are processed in batches
Preview Support
- Preview mode allows you to inspect generated docs before a pull request is created
- You can cancel or adjust configuration if results are not satisfactory
No Auto-Merge
- All documentation is proposed via a pull request
- Human review is always required
Respect Existing Structure
- Existing documentation files are never overwritten without review
- Directory structure and framework conventions are preserved
What Bootstrap Does Not Do
- It does not rewrite existing documentation
- It does not infer undocumented behavior
- It does not execute code
- It does not modify non-documentation files
Bootstrap is a starting point, not a replacement for review.
Availability
| Plan | Public API Detection |
|---|---|
| Free | ❌ Not available |
| Pro | ✅ Available |
| Enterprise | ✅ Available |
Bootstrap is intentionally unavailable on the Free plan due to its larger scope and resource usage.
Summary
Bootstrap Documentation provides a safe way to establish documentation for mature codebases—without sacrificing reviewability or control.
Once complete, Docify continues maintaining documentation incrementally.