docs(CLAUDE.md): add project organization guidelines for root cleanup

Document proper organization:
- Root directory - keep minimal (configs, CI/CD, package management)
- /txt/ folder - task lists and reports (with README guide)
- /docs/ folder - project-wide principles (not subproject docs)
- /docs/ subproject folders - each project has its own documentation

Rules:
- Move one-off scripts to /txt/
- Move reports and analyses to /txt/ with date suffix
- Move subproject docs to subproject /docs/ folders
- Keep root clean (only essentials: CLAUDE.md, config, CI/CD, pkg mgmt)

This enables quick navigation and prevents root clutter.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-01-23 17:29:28 +00:00
parent e96cfd8c18
commit b0e9d17de3

View File

@@ -628,8 +628,29 @@ From [.github/workflows/README.md](./.github/workflows/README.md):
## Project Organization Guidelines
### Root-Level Docs
### Root Directory (Clean)
Keep project root minimal - only essential files:
- Configuration: `.env.local`, `.gitignore`, `.npmrc`, `lefthook.yml`
- CI/CD: `Jenkinsfile`, `.gitlab-ci.yml`
- Build: `docker-compose.ghcr.yml`, `.dockerignore`
- Package: `package.json`, `package-lock.json`
- Testing: `playwright.config.ts`
- Docs: `CLAUDE.md` (AI Assistant Guide)
**Rule**: Move one-off scripts and old reports to `/txt/` folder
### Task Lists & Reports (`/txt/`)
For progress tracking, analysis documents, and delivery summaries:
- Current task lists (dated: `TASKNAME_2026-01-23.txt`)
- Dependency update reports
- Delivery and audit summaries
- Old reports archived with clear purpose
See: `txt/README.md` for organization guide
### Root-Level Docs (`/docs/`)
Keep `/docs/` focused on project-wide guidance:
- Core principles and patterns
- Architecture documentation
- Setup and installation
- Development workflows
@@ -642,7 +663,8 @@ Each standalone subproject maintains its own `/docs/` folder:
- `codegen/docs/` - CodeForge IDE documentation
- `gameengine/docs/` - Game engine technical details
- `postgres/docs/` - PostgreSQL dashboard guides
- etc.
- `fakemui/docs/` - Component library guides
- `packages/*/docs/` - Package-specific documentation
**Rule**: New detailed documentation → place in subproject `/docs/`, not root
@@ -652,6 +674,7 @@ Each standalone subproject maintains its own `/docs/` folder:
- **Component categorization** - atoms/, inputs/, surfaces/, navigation/, etc.
- **Preserve legacy code** - in legacy/ or archived folders with clear purpose
- **Keep things browseable** - short file lists per directory
- **Clean root** - move reports and utilities out of project root
---