| 1 | # Prompt Include Plugin DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own automatic prompt injection of persistent behavioral rules and preferences from `*.promptinclude.md` files. |
| 6 | |
| 7 | ## Ownership |
| 8 | |
| 9 | - `helpers/scanner.py` owns workspace scanning, ignore handling, token budgeting, and trimming. |
| 10 | - `prompts/` owns prompt-inclusion fragments. |
| 11 | - `extensions/` owns prompt injection hooks. |
| 12 | - `default_config.yaml`, `plugin.yaml`, `README.md`, and `webui/` own defaults, metadata, behavior notes, and settings UI. |
| 13 | |
| 14 | ## Local Contracts |
| 15 | |
| 16 | - Respect gitignore-style filtering, per-file budgets, and total token budgets. |
| 17 | - Include only intended promptinclude files from configured workspaces. |
| 18 | - Keep scan result status fields accurate for skipped, cropped, and included files. |
| 19 | |
| 20 | ## Work Guidance |
| 21 | |
| 22 | - Coordinate scanner changes with prompt fragments so included content is clearly attributed. |
| 23 | |
| 24 | ## Verification |
| 25 | |
| 26 | - Smoke-test include, ignore, crop, and over-budget cases after scanner changes. |
| 27 | |
| 28 | ## Child DOX Index |
| 29 | |
| 30 | No child DOX files. |