Document project structure boundaries#13
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
More reviews will be available in 48 minutes and 21 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR adds two documentation artifacts to guide AI agents on repository boundaries and structure. A new ChangesRepository Structure Guidance for AI Agents
🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly Related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a dedicated, repo-level reference (PROJECT_STRUCTURE.md) that documents which top-level areas are production/runtime vs documentation, deployment, learning/sandbox, generated, or sensitive, and links to it from AGENTS.md to guide agent-driven edits.
Changes:
- Added
PROJECT_STRUCTURE.mddescribing repository boundaries and safe-editing rules by task type. - Updated
AGENTS.mdto referencePROJECT_STRUCTURE.mdfor boundary questions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| PROJECT_STRUCTURE.md | New boundary/reference doc covering runtime vs non-runtime areas, sensitive paths, generated output, and safe-editing guidance. |
| AGENTS.md | Adds a short section pointing agents to the new structure boundary reference. |
| | `data/` | Archive/reference, local-only | Root `data/` contains local notes and archive material, is ignored by Git, and is excluded from the Docker context. Do not confuse it with `app/data/`. | | ||
| | `Resume/` | Archive/reference, local-only | Contains local resume reference material and is ignored by Git. Verify before editing or publishing. | |
| | `docker-compose.prod.yml` | Production app, Nginx, and Certbot composition | Treat as deployment-sensitive. | | ||
| | `.github/workflows/` | GitHub Actions build and deployment automation | Treat as CI/CD-sensitive. | | ||
| | `nginx/` | Tracked Nginx configuration mounted by production Compose | Treat as host-side production infrastructure. | | ||
| | `certbot/` | Local host-side certificate state mounted by production Compose | Do not expose or modify certificate material without explicit approval. | |
| |---|---|---| | ||
| | `.env*` | Local environment configuration and secrets | Never read, expose, or modify real values without a specific security-conscious instruction. | | ||
| | `secrets/` | Ignored local secret material | Never inspect contents, publish files, or include values in output. | | ||
| | `certbot/` | Local certificate state | Treat as sensitive host-side infrastructure. | |
Summary
Validation
Notes
Summary by CodeRabbit