Skip to content

chore: add architecture overview#7777

Open
mhartington wants to merge 1 commit intomainfrom
tech-overview
Open

chore: add architecture overview#7777
mhartington wants to merge 1 commit intomainfrom
tech-overview

Conversation

@mhartington
Copy link
Copy Markdown
Member

@mhartington mhartington commented Apr 6, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive architecture documentation covering system design, application configuration, environment setup, and deployment patterns
    • Updated README with link to architecture documentation

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 6, 2026

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

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Apr 6, 2026 4:08pm
docs Error Error Apr 6, 2026 4:08pm
eclipse Ready Ready Preview, Comment Apr 6, 2026 4:08pm
site Ready Ready Preview, Comment Apr 6, 2026 4:08pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 6, 2026

Walkthrough

This pull request introduces a new ARCHITECTURE.md document detailing the monorepo structure, cross-app routing model, deployment configuration, and development guidance. A reference link is added to README.md pointing to the new documentation.

Changes

Cohort / File(s) Summary
Documentation
ARCHITECTURE.md, README.md
New architectural documentation describing the pnpm monorepo structure, two-layer composition model, cross-zone rewrite rules, request flow, URL/metadata helpers, and deployment responsibilities; link added to README.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: add architecture overview' directly and clearly describes the main change—adding a new ARCHITECTURE.md document that documents the monorepo structure and cross-app routing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@argos-ci
Copy link
Copy Markdown

argos-ci bot commented Apr 6, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Apr 6, 2026, 4:17 PM

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
ARCHITECTURE.md (1)

121-121: Use compound adjective hyphenation.

Line 121 should use “query-param-based routes” for correct compound adjective style.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@ARCHITECTURE.md` at line 121, Update the phrase in the sentence describing
tag redirects so the compound adjective is hyphenated: replace the occurrence of
"query-param based routes" (in the sentence mentioning "tag redirects") with
"query-param-based routes" to use correct compound-adjective style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@ARCHITECTURE.md`:
- Around line 3-8: The intro currently states the repo has three Next.js apps
but omits apps/eclipse; update the opening sentence to either list all four
multi-zone apps (add `apps/eclipse` alongside `apps/site`, `apps/blog`,
`apps/docs`) or change the scope phrase to explicitly read that the list covers
“multi-zone apps only” so the statement is accurate and aligns with README.md.
- Around line 294-299: The statement "Root `pnpm dev` starts all relevant apps"
is ambiguous because the list omits Eclipse; update the ARCHITECTURE.md entry
that starts with "Root `pnpm dev` starts all relevant apps:" to either add the
missing Eclipse line "- eclipse on `http://localhost:3003`" to the bullet list
(so it includes site, docs, blog, eclipse) or rephrase the header to "starts the
multi-zone apps" and keep the existing bullets; edit the sentence and/or bullets
that include the literal "Root `pnpm dev`" and the host URLs so the doc
consistently reflects the Eclipse app or uses the broader "multi-zone apps"
wording.

---

Nitpick comments:
In `@ARCHITECTURE.md`:
- Line 121: Update the phrase in the sentence describing tag redirects so the
compound adjective is hyphenated: replace the occurrence of "query-param based
routes" (in the sentence mentioning "tag redirects") with "query-param-based
routes" to use correct compound-adjective style.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c60909c0-6f82-4a4b-af31-c103a669b201

📥 Commits

Reviewing files that changed from the base of the PR and between 67daddc and e8bdf11.

📒 Files selected for processing (2)
  • ARCHITECTURE.md
  • README.md

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.

1 participant