FAQs
This page answers the most common questions and concerns.
Will Docify rewrite my documentation?
No.
Docify only proposes small, targeted changes related to recent code changes.
It does not:
- Rewrite entire pages
- Change unrelated sections
- Alter your documentation structure
Every change goes through a pull request.
Can I disable Docify?
Yes.
You can disable Docify by:
- Ignoring a pull request
- Adding ignore rules in
docify.yml - Uninstalling the GitHub App
Docify never forces changes.
Does Docify use AI?
Sometimes — but only in limited, controlled ways.
AI may be used to:
- Improve wording
- Explain diffs
- Fill small documentation templates
AI is not used to:
- Detect code changes
- Decide what to document
- Auto-merge pull requests
You always review the output.
Can I limit which files are documented?
Yes.
You can define ignore rules in docify.yml, for example:
docs:
ignore:
- src/internal/**
- scripts/**Ignored paths are never documented or scanned.
What if my documentation lives in another repository?
Docify supports cross-repository documentation.
You can configure:
- Code in one repo
- Docs in another repo
Docify will open documentation PRs in the target repository.
What if Docify opens an incorrect PR?
You can:
- Edit the PR
- Request changes
- Close it
Docify learns nothing automatically from merges and does not repeat mistakes unless the code truly changed again.
How do I uninstall Docify?
To uninstall:
- Go to GitHub → Settings → Applications
- Find Docify
- Click Uninstall
After uninstall:
- No further actions occur
- Existing PRs remain unchanged
- No data is retained
- The configuration file can be deleted manually if desired
Summary
Docify is designed to be:
- Predictable
- Conservative
- Easy to disable
- Safe to trial
If you are ever unsure, start with one repository.