Skip to content

Document project structure boundaries#13

Merged
TaiChi112 merged 3 commits into
mainfrom
docs/project-structure-boundaries
Jun 2, 2026
Merged

Document project structure boundaries#13
TaiChi112 merged 3 commits into
mainfrom
docs/project-structure-boundaries

Conversation

@TaiChi112

@TaiChi112 TaiChi112 commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Added PROJECT_STRUCTURE.md to document repository boundaries.
  • Clarified production, documentation, deployment, learning, archive, and sensitive areas.
  • Updated AGENTS.md to point agents to the structure boundary reference.

Validation

  • git diff --check passed
  • bun run build passed

Notes

  • This PR does not move, rename, or delete folders.
  • This PR does not fix lint debt.
  • This PR does not change runtime behavior.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive project structure documentation with folder organization details and contributor guidelines for repository changes.

Copilot AI review requested due to automatic review settings June 2, 2026 13:08
@vercel

vercel Bot commented Jun 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
personal-profile-prototype Ready Ready Preview, Comment Jun 2, 2026 1:21pm

@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@TaiChi112, we couldn't start this review because you've reached your PR review rate limit.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 08b350d7-0354-4612-90f1-627173d950e0

📥 Commits

Reviewing files that changed from the base of the PR and between 0bd70f0 and 17334af.

📒 Files selected for processing (2)
  • AGENTS.md
  • PROJECT_STRUCTURE.md
📝 Walkthrough

Walkthrough

This PR adds two documentation artifacts to guide AI agents on repository boundaries and structure. A new PROJECT_STRUCTURE.md categorizes all top-level directories and files by purpose and editing constraints, and AGENTS.md is extended with a reference section directing agents to consult this guide for boundary questions.

Changes

Repository Structure Guidance for AI Agents

Layer / File(s) Summary
Repository structure categorization and editing rules
PROJECT_STRUCTURE.md
New document that categorizes top-level directories and files by purpose (production runtime, documentation, database, deployment, learning/sandbox/archive, sensitive, generated) and specifies task-specific editing rules and approval requirements.
AI agent instruction extension with structure reference
AGENTS.md
Added "Project Structure Reference" subsection directing agents to check PROJECT_STRUCTURE.md for boundary questions, clarifying that learning/sandbox/archive folders are not production runtime without verification, and prohibiting top-level folder reorganization without explicit approval.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Possibly Related PRs


🐰 A warren of folders, neat and tidy,
Where agents roam with rules less flighty,
Prod and learning kept apart with care,
No moving folders here and there!
With boundaries clear, the code stays right,

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Document project structure boundaries' directly and clearly describes the main change: adding documentation about project structure boundaries in new and updated files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/project-structure-boundaries

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing repository boundaries and safe-editing rules by task type.
  • Updated AGENTS.md to reference PROJECT_STRUCTURE.md for 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.

Comment thread PROJECT_STRUCTURE.md Outdated
Comment on lines +72 to +73
| `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. |
Comment thread PROJECT_STRUCTURE.md Outdated
| `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. |
Comment thread PROJECT_STRUCTURE.md Outdated
|---|---|---|
| `.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. |
@TaiChi112 TaiChi112 merged commit 2285e66 into main Jun 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants