add dokuwiki sources for dev

README.md

@@ -58,6 +58,35 @@ When adding new internal classes under the `dokuwiki\plugin\luxtools\` namespace
 JavaScript is split into small modules under `js/` and registered via `action.php` so DokuWiki loads them in order.
 
 
+## IDE support (developer notes)
+
+This plugin extends and uses DokuWiki core classes (for example `dokuwiki\Extension\ActionPlugin`, `dokuwiki\Extension\SyntaxPlugin`, renderers, handlers). If you only open the plugin folder in your IDE, those types may show as “unknown”.
+
+DokuWiki does not currently ship an official PHP “SDK”/stub package for IDEs. The most reliable way to get full type navigation and autocomplete is to have the DokuWiki sources available in your workspace.
+
+Two recommended setups:
+
+### Option A: Add DokuWiki as a git submodule (recommended for a single-folder workspace)
+
+From the plugin root:
+
+```bash
+git submodule add https://github.com/dokuwiki/dokuwiki.git _dokuwiki
+git submodule update --init --recursive
+```
+
+The repository includes a VS Code config in `.vscode/settings.json` that points Intelephense at `./_dokuwiki/*` so the classes resolve.
+
+`deploy.sh` excludes `_dokuwiki/` to avoid deploying the dev-only checkout.
+
+### Option B: Use a separate DokuWiki checkout next to the plugin (recommended if you don’t want submodules)
+
+- Clone DokuWiki into a sibling folder (outside this repo)
+- Open a multi-root VS Code workspace with both folders
+
+This avoids changing the git state of the plugin repo, but still gives the IDE access to DokuWiki’s class definitions.
+
+
 ## Configuration
 
 luxtools is configured via its dedicated admin page: