Skip to content

Document repository architecture overview#3299

Open
itsalexcm wants to merge 1 commit into
mainfrom
docs/repository-architecture-overview
Open

Document repository architecture overview#3299
itsalexcm wants to merge 1 commit into
mainfrom
docs/repository-architecture-overview

Conversation

@itsalexcm
Copy link
Copy Markdown
Contributor

Why

Contributors benefit from a concise mental model of how docs-builder splits across projects before diving into individual assemblies or weighing repo splits.

What

Adds a Development guide page that groups the monorepo into six conceptual layers (Markdown rendering, shared configuration, assembly and navigation graph, CLI tooling, APIs and services, infrastructure), links to the main .csproj paths and folders, includes a simplified dependency diagram, and notes reasonable boundaries if we ever extract NuGet packages or separate repos.

Updates the Development index to replace the placeholder with a link to this overview.

Made with Cursor

Maps the monorepo into six conceptual layers (Markdown engine, configuration,
assembly graph, CLI tools, APIs/services, infra) with links to projects and a
high-level dependency diagram.

Co-authored-by: Cursor <cursoragent@cursor.com>
@itsalexcm itsalexcm added the documentation Improvements or additions to documentation label May 11, 2026
@itsalexcm itsalexcm requested review from a team as code owners May 11, 2026 17:06
@itsalexcm itsalexcm requested a review from technige May 11, 2026 17:06
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Review Change Stack
No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: db583c13-01a1-4077-9f2f-e73186f216cf

📥 Commits

Reviewing files that changed from the base of the PR and between ef78eec and 80ddbc7.

📒 Files selected for processing (2)
  • docs/development/architecture-components.md
  • docs/development/index.md

📝 Walkthrough

Walkthrough

This PR adds architecture documentation to guide future development and modularization decisions. A new architecture-components.md file maps the repository's existing .NET projects and infrastructure into six conceptual blocks, visualizes their dependencies using a Mermaid flowchart, and outlines suggested boundaries for potential future extraction (Markdown library, site coherence engine, assembler pipeline, frontend, and API/Lambda deployables). The development index is updated to link to this new guide.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Document repository architecture overview' directly and clearly describes the main change—adding documentation for the repository's architecture—matching the primary objective of the PR.
Description check ✅ Passed The description is well-structured, clearly explaining the motivation ('Why'), the implementation details ('What'), and directly relating to the changeset of adding architecture documentation and updating the development index.
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
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/repository-architecture-overview

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant