Docs
Documentation
Short guides for site owners. No programming knowledge needed. If you are new to CompatNav, start with Getting started.
Plugin developers: the Developer API page shows how an add-on can run scans and read the report.
Start here
From install to a clear answer, in three steps
- 1Getting startedInstall CompatNav, choose the PHP version you plan to move to, and run your first scan.
- 2Reading the reportWhat the verdict means, the difference between “Will break” and “Deprecation notice”, and how to share the report.
- 3Not ready yet: what to doThe report says “Not ready yet”. Four ways forward: update, contact the author, replace, or ask a developer.
Everything else
Answers and reference
Files that could not be checked
Why some files are listed as “could not be checked”, why that matters for the verdict, and what you can do.
FAQ
Short answers about what CompatNav does, what it doesn’t do, and what its results mean.
Privacy
What CompatNav stores on your site, and why nothing leaves it.
Getting help
Where to ask a question or report a wrong result, and what to include so we can help quickly.
Developer API
For plugin developers: start CompatNav scans in the background, read the report and its findings, check code and plugin zips, and react when a scan finishes. CompatNav 1.1.0 and newer.