|
| 1 | +--- |
| 2 | +description: Repository-wide quality gates for PrestaShop DevDocs changes |
| 3 | +alwaysApply: true |
| 4 | +--- |
| 5 | + |
| 6 | +# PrestaShop DevDocs: Systematic Quality |
| 7 | + |
| 8 | +Apply this to every docs area: hooks, Admin API, modules, themes, webservice, basics, contribution guides, and all version branches. |
| 9 | + |
| 10 | +## Work Systemically |
| 11 | + |
| 12 | +- Treat review comments and maintainer follow-up commits as examples of a class of issue. |
| 13 | +- Audit the full changed scope for similar issues before editing. |
| 14 | +- For version migrations, verify behavior against the target branch, not previous docs. |
| 15 | +- Prefer deleting obsolete pages over preserving stale documentation. |
| 16 | + |
| 17 | +## Source of Truth |
| 18 | + |
| 19 | +- Core behavior: target `PrestaShop/PrestaShop` branch. |
| 20 | +- Theme behavior: `classic-theme` and `hummingbird`. |
| 21 | +- Module behavior: official native module repositories. |
| 22 | +- Existing docs are not authoritative when source code disagrees. |
| 23 | + |
| 24 | +## Content Accuracy |
| 25 | + |
| 26 | +- Examples must be current, minimal, and copied from real source behavior. |
| 27 | +- Do not include unrelated surrounding code, constants, comments, or half-copied arrays. |
| 28 | +- Code fence language must match the snippet syntax. |
| 29 | +- Parameter arrays must be complete for the current call, including references and flags. |
| 30 | +- Never leave placeholders, partial links, or known-broken URLs. |
| 31 | + |
| 32 | +## Verification Before Push |
| 33 | + |
| 34 | +- Run area-specific validators and a CI-equivalent Hugo build. |
| 35 | +- Check changed links and examples against source. |
| 36 | +- Do not push until validation passes. |
| 37 | + |
| 38 | +## Continuous Improvement |
| 39 | + |
| 40 | +When a new failure pattern is discovered: |
| 41 | +- Add it to the relevant rule. |
| 42 | +- Add or improve a deterministic local check when possible. |
| 43 | +- Re-run the full-scope audit to prove no similar cases remain. |
0 commit comments