Skip to content

documentation_naming_policy.md

Documentation Naming Policy - Grid Building Plugin

All documentation files (Markdown .md files) in this project must use snake_case naming. This applies to all new and existing documentation in the repository, including but not limited to:

  • System architecture docs
  • Test and factory guides
  • Placement and collision docs
  • Any other project or feature documentation

Example:

  • project_architecture.md (not project-architecture.md or ProjectArchitecture.md)
  • collision_layer_system.md (not collision-layer-system.md)
  • placement_chain.md (not PLACEMENT_CHAIN.md)

Rationale:

  • Ensures consistency and discoverability
  • Matches codebase and resource naming conventions
  • Avoids confusion and accidental duplication

Enforcement:

  • All contributors and AI assistants must follow this rule for all documentation changes.
  • Update any references in code or comments to use the new snake_case names when renaming files.

Last updated: 2025-08-07