[AI Setup] Improve .claude/ structure and CLAUDE.md clarity#11360
Open
[AI Setup] Improve .claude/ structure and CLAUDE.md clarity#11360
Conversation
- Promote analysis/ from gitignored throwaway to checked-in docs/analysis/ - Add tmp/ directory (gitignored) with reviews/ and screenshots/ subdirs - Add "Last updated" dates to all living reference docs - Move PM_PROMOTIONS.md into docs/pm-promotions.md - Add documentation structure section to CLAUDE.md explaining folder purposes
CLAUDE.local.md contains user-specific AI instructions and should not be committed. The file remains at the project root for each developer to maintain locally.
Project instruction files belong at the root for discoverability, like README.md. The .claude/ directory is for tooling config (settings, tmp, cached docs), not the primary instruction files. Aligns with CIAB Admin and Dev Tools conventions where CLAUDE.md lives at root.
Contributor
Test the buildOption 1. Jetpack Beta
Option 2. Jurassic Ninja - available for logged-in A12s🚀 Launch a JN site with this branch 🚀 ℹ️ Install this Tampermonkey script to get more options. Build info:
Note: the build is updated when a new commit is pushed to this PR. |
Contributor
|
Size Change: 0 B Total Size: 956 kB ℹ️ View Unchanged
|
vladolaru
changed the title
The file mixed legacy and current naming inconsistently, had duplicate sections (changelog in two places, code organization repeating directory structure), and used prose where tables would be more scannable. Add a Naming & Branding table distinguishing WooPayments (official brand), WooCommerce Payments (legacy name), WCPay (shorthand), and the frozen woocommerce-payments slug. Convert verbose sections to tables, eliminate redundancy, and tighten prose. 352 → 285 lines with no information loss.
vladolaru
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes proposed in this Pull Request
Aligns our
.claude/documentation structure for consistency across projects, and improvesCLAUDE.mdfor AI agent efficiency. No runtime impact — documentation and directory structure only.Changes:
Move
CLAUDE.mdto project root — project instruction files belong at root for discoverability (likeREADME.md).Improve
CLAUDE.mdclarity and token efficiency — eliminate duplicate sections (changelog was in two places, code organization repeated directory structure), convert verbose prose to scannable tables, tighten language. 352 → 285 lines with no information loss.Add Naming & Branding guide — distinguish WooPayments (official brand), WooCommerce Payments (legacy name), WCPay (internal shorthand), and the frozen
woocommerce-paymentsslug (kept for backward compatibility).Promote
analysis/— from gitignored throwaway (.claude/analysis/) to checked-indocs/analysis/. Research findings (Stripe API behavior, caching gotchas) are valuable across sessions and developers.Add
tmp/directory — gitignored.claude/tmp/withreviews/andscreenshots/subdirs for transitory files (code review outputs, UI screenshots).Living docs convention — added
**Last updated:** YYYY-MM-DDheader to all reference docs (payment-flow.md,mode-system.md,test-patterns.md,pm-promotions.md). Makes staleness visible.Move
PM_PROMOTIONS.md— from.claude/root todocs/pm-promotions.md. Root should only have config files.Housekeeping — add
.serena/to.gitignore, addCLAUDE.local.mdto.gitignore(user-specific, should not be committed).Testing instructions
No runtime impact. Verify:
CLAUDE.mdexists at project root and is readable.claude/docs/contains reference docs with "Last updated" headers.claude/tmp/directory exists but contents are gitignored.claude/analysis/no longer exists (moved to.claude/docs/analysis/)npm run changelogto add a changelog file, choosepatchto leave it empty if the change is not significant. You can add multiple changelog files in one PR by running this command a few times.Post merge