Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs_build/dev/ProjectInstructions/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ READ THIS FIRST
9. Follow OWNER governance decisions.
10. When guidance conflicts, newest OWNER-approved guidance wins.
11. Batch Governance Mode is the default for governance, documentation, and administrative work.

Addendum index:
- Canonical Repository Structure: project-instructions/addendums/canonical-repository-structure.md
39 changes: 39 additions & 0 deletions project-instructions/addendums/canonical-repository-structure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Canonical Repository Structure

## Purpose

Establish the canonical repository structure for future development and reduce technical debt.

## Canonical Structure

Tools:
- toolbox/{tool-name}/index.html

Tool assets:
- assets/toolbox/{tool-name}/js/index.js
- assets/toolbox/{tool-name}/css/index.css

Themes:
- assets/theme-v1/
- assets/theme-v2/

Shared JavaScript:
- assets/js/shared/

Engine:
- src/engine/{feature-name}/

API:
- api/{feature-name}/

Serverside:
- serverside/{feature-name}/

## Rules

- Theme first.
- Tool CSS second.
- Shared functionality belongs in assets/js/shared/.
- No new scattered JS folders.
- No new scattered CSS folders.
- New development follows the canonical structure.
Loading