Docs Sync Policy
Policy Statement
Section titled “Policy Statement”If a PR changes gameplay behavior, registry content, recipes, handlers, dimension logic, or enchantment behavior, it must include in the same PR:
- matching documentation updates
- matching changelog updates
- regenerated source-derived docs pages
Enforcement
Section titled “Enforcement”- CI/local gate:
scripts/check-doc-sync.sh - PR checklist gate:
.github/pull_request_template.md
Trigger File Patterns
Section titled “Trigger File Patterns”Mod source changes in these directories trigger docs requirements:
src/main/java/**src/main/resources/data/sculkmancy/**src/main/resources/assets/sculkmancy/**
When triggered, at least one docs file and one changelog file must change.