Bootstrap AI agent environment and repository foundation#8
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
📝 WalkthroughWalkthroughThis PR adds repository AI/agent guidance, revises README to use Bun and Docker Compose with SSH deploys to GCP/Azure, introduces a new database systems docs subsection with navigation and placeholder pages, and updates a localization string and a docs edit link. ChangesRepository Governance and Instruction Framework
Deployment Architecture and Tooling Documentation
Database Systems Documentation
Content and Link Updates
🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Analysis CompleteGenerated ECC bundle from 7 commits | Confidence: 50% View Pull Request #9Repository Profile
Changed Files (15)
Top hotspots
Top directories
Analysis Depth Readiness (evidence-backed, 29%)ECC Tools uses this to decide whether recommendations should stay at commit-history/setup guidance or expand into CI, security, harness, reference-set, AI-routing, and team backlog work.
Reference Set Readiness (0/7, 0%)
Likely Future Issues (3)
Suggested Follow-up Work (3)
Copy-ready bodies db: add migration follow-up for app/models/theme/locales/en.ts + docs/(computer_science)/systems/db/agentic-applications/index.mdx ## Summary
- Add the missing migration or schema rollout step for the recently changed schema surface.
## Why
- Backfill the missing migration artifact before another schema or model change lands on top.
## Touched paths
- `app/models/theme/locales/en.ts`
- `docs/(computer_science)/systems/db/agentic-applications/index.mdx`
## Validation
- Create the migration or schema rollout artifact used by this repo.
- Run the repo migration / schema validation flow and verify the changed models still match production expectations.test: add data integration coverage for docs/(computer_science)/systems/db/agentic-applications/index.mdx + docs/(computer_science)/systems/db/foundations/index.mdx ## Summary
- Add integration coverage for the recently changed repository, query, or database-access surface.
## Why
- Backfill integration coverage before another data-layer change lands on the touched surface.
## Touched paths
- `docs/(computer_science)/systems/db/agentic-applications/index.mdx`
- `docs/(computer_science)/systems/db/foundations/index.mdx`
## Validation
- Add or extend integration coverage for the changed repository, query, or database-access path.
- Exercise realistic read/write flows or equivalent persistence boundary cases.test: add budget evidence for CLAUDE.md ## Summary
- Add budget or usage-limit validation for the recently changed AI routing or model-call surface.
## Why
- Backfill cost, token, or usage-limit validation before another model-routing change lands on the touched surface.
## Touched paths
- `CLAUDE.md`
## Validation
- Add or extend budget, token, usage-limit, or model-routing regression coverage for the changed path.
- Verify the route still enforces plan limits, retry caps, fallback behavior, or explicit cost controls.Detected Workflows (2)
Generated Instincts (18)
After merging, import with: Files
|
Contributor
There was a problem hiding this comment.
Pull request overview
Bootstraps the repository's AI-agent guidance and standardizes Bun as the canonical package manager, while updating the README to reflect the current SSH-based GHCR deployment and adding placeholder pages for the Database documentation section. Also updates one hero label in en.ts and refreshes the edit-link URL in the Computer Science docs landing page.
Changes:
- Add
AGENTS.md,CLAUDE.md, and.github/copilot-instructions.mdagent instruction layers establishing repository boundaries, critical rules, Bun-only package policy, and validation expectations. - Rewrite README sections (Tech Stack, Project Structure, Testing, Setup, Env Vars, CI/CD diagram, Quick Reference scripts) to reflect Bun usage, the new
deploy.ymlGHCR + SSH pipeline, and Node 20.19 base image. - Add
docs/(computer_science)/systems/db/meta.jsonand seven WIP placeholderindex.mdxfiles (overview, foundations, schema-design, reliability, performance, agentic-applications, labs); update the CS docs edit-link URL and tweak one hero label string.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New canonical agent guidance document. |
| CLAUDE.md | Thin Claude Code adapter importing @AGENTS.md. |
| .github/copilot-instructions.md | Concise Copilot baseline pointing to AGENTS.md. |
| README.md | Syncs documentation with Bun, Node 20.19, GHCR/SSH deployment, and current env-var layout. |
| docs/(computer_science)/systems/db/meta.json | Registers the seven Database sub-pages. |
| docs/(computer_science)/systems/db/{overview,foundations,schema-design,reliability,performance,agentic-applications,labs}/index.mdx | WIP placeholder pages with consistent frontmatter and Callout. |
| docs/(computer_science)/index.mdx | Updates edit-link URL to the current repository path. |
| app/models/theme/locales/en.ts | Replaces hero copy with personal introduction (not mentioned in PR description). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| export const EN_LABELS = { | ||
| nav: { home: 'Home', feed: 'Feed', projects: 'Projects', library: 'Library', articles: 'Articles', blog: 'Blog', docs: 'Docs', resume: 'Resume', dashboard: 'Analytics', podcast: 'Podcast', contact: 'Contact' }, | ||
| hero: { titlePrefix: 'Building the', titleHighlight: 'Future (CI/CD Active Auto!)', description: 'Software Engineering crafting scalable applications.', btnProjects: 'View Projects', btnArticles: 'Read Articles' }, | ||
| hero: { titlePrefix: 'Hi, I\'m Anothai (TaiChi)', titleHighlight: 'Architecting Code. Documenting the Journey.', description: 'Software Engineer. Welcome to my digital garden where I showcase my portfolio and share deep dives into software architecture and development.', btnProjects: 'View Projects', btnArticles: 'Read Articles' }, |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/copilot-instructions.md:
- Line 13: The prose line that lists filenames (containing the token
`.github/...` in the sentence that mentions auth.ts, Dockerfile,
docker-compose*.yml, .github/workflows/deploy.yml, next.config.ts, and
source.config.ts) should use the official platform casing “GitHub” instead of
`.github` when referring to the platform; update that sentence to replace the
`.github` platform reference with “GitHub” while leaving the actual file names
unchanged and preserving the list punctuation and casing.
- Around line 7-15: The file contains a duplicated detailed repository policy
block (the bullet list beginning with "Inspect nearby code and conventions
before editing." through "Do not add dependencies...") that should be removed;
replace that block in .github/copilot-instructions.md with a short pointer like
"Refer to AGENTS.md for canonical agent and repository policies" to keep this
adapter thin, and ensure no other unrelated lines are modified and AGENTS.md
remains the canonical source.
In `@README.md`:
- Line 46: The README's authentication entry currently says "NextAuth.js 4" but
AGENTS.md documents "NextAuth.js v5 beta"; update the README table row for
"Authentication" to match the canonical stack by replacing "NextAuth.js 4" with
"NextAuth.js v5 beta" (or vice versa if you prefer AGENTS.md to change) so both
docs consistently state the same NextAuth version; ensure the phrasing
("Pluggable OAuth providers; JWT session strategy with role augmentation")
remains unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 18d34823-1f87-4dde-b08b-66dd0f79c1dd
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (14)
.github/copilot-instructions.mdAGENTS.mdCLAUDE.mdREADME.mdapp/models/theme/locales/en.tsdocs/(computer_science)/index.mdxdocs/(computer_science)/systems/db/agentic-applications/index.mdxdocs/(computer_science)/systems/db/foundations/index.mdxdocs/(computer_science)/systems/db/labs/index.mdxdocs/(computer_science)/systems/db/meta.jsondocs/(computer_science)/systems/db/overview/index.mdxdocs/(computer_science)/systems/db/performance/index.mdxdocs/(computer_science)/systems/db/reliability/index.mdxdocs/(computer_science)/systems/db/schema-design/index.mdx
Comment on lines
+7
to
+15
| - Inspect nearby code and conventions before editing. | ||
| - Keep changes focused and do not modify unrelated files. | ||
| - Bun is the canonical package manager. Use `bun.lock` as the dependency lockfile; do not run `npm install` or commit `package-lock.json`. | ||
| - Documentation content under `/docs` includes both Markdown and MDX files. | ||
| - For application TypeScript/React changes, run `bun run lint` and `bun run build`. | ||
| - For approved Prisma schema changes, edit `prisma/schema.prisma`, use the development migration workflow documented in `AGENTS.md`, and never edit or delete applied migrations. | ||
| - Treat `auth.ts`, `Dockerfile`, `docker-compose*.yml`, `.github/workflows/deploy.yml`, `next.config.ts`, and `source.config.ts` as sensitive areas. Explain risks and use task-appropriate validation when a user explicitly requests changes there. | ||
| - Never read, expose, or modify real secret values from `.env*` unless the user provides a specific security-conscious instruction and the action is strictly necessary. | ||
| - Do not add dependencies, skills, hooks, MCP integrations, custom agents, or additional instruction layers without explicit approval. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Keep Copilot adapter thin to avoid policy drift.
Lines 7-15 duplicate detailed repository policy that should remain canonical in AGENTS.md. Keep this file as a concise compatibility layer and defer detailed rules to AGENTS.md to prevent divergence.
As per coding guidelines, “Use the canonical repository guidance in AGENTS.md for agent workflows; keep detailed policy in AGENTS.md rather than duplicating across adapter files”.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: The official name of this software platform is spelled with a capital “H”.
Context: ..., Dockerfile, docker-compose*.yml, .github/workflows/deploy.yml, next.config.ts`...
(GITHUB)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/copilot-instructions.md around lines 7 - 15, The file contains a
duplicated detailed repository policy block (the bullet list beginning with
"Inspect nearby code and conventions before editing." through "Do not add
dependencies...") that should be removed; replace that block in
.github/copilot-instructions.md with a short pointer like "Refer to AGENTS.md
for canonical agent and repository policies" to keep this adapter thin, and
ensure no other unrelated lines are modified and AGENTS.md remains the canonical
source.
This was referenced Jun 2, 2026
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
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.
Summary
AGENTS.mdpackage-lock.jsonValidation
bun run buildpassed/docs,/docs/systems/db, and/docs/systems/db/overviewreturned 200 during local validationReview Notes
.github/copilot-instructions.mdthinner.github/workflows/deploy.ymlpath unchanged because it is the correct repository pathNotes