Skip to content

docs: add brownfield integration guide for existing .NET apps#183

Open
antosubash wants to merge 3 commits into
mainfrom
claude/dotnet-integration-guide-024RU
Open

docs: add brownfield integration guide for existing .NET apps#183
antosubash wants to merge 3 commits into
mainfrom
claude/dotnet-integration-guide-024RU

Conversation

@antosubash
Copy link
Copy Markdown
Owner

Summary

Adds a new "Brownfield Integration" page under Getting Started that walks teams with large, existing .NET applications through adopting SimpleModule incrementally.

The guide is structured around four migration phases (Coexist → First module → Cross-cutting modules → Module-first), so readers can stop at any stable end-state rather than committing to a full rewrite.

What's covered

  • Phase 1 (Coexist): exact csproj and Program.cs changes to stand the framework up next to legacy controllers, MVC, EF Core, and existing auth — with no behavioural change.
  • Phase 2 (First module): how to pick a low-risk candidate, scaffold via sm new module, and bridge to legacy data via an adapter before moving the schema.
  • Phase 3 (Cross-cutting modules): a catalogue of what each cross-cutting module replaces, when to adopt it, and a parallel-run pattern for safe cutovers.
  • Phase 4 (Module-first): what a healthy steady-state looks like.
  • Brownfield-specific notes on authentication (no OpenIddict requirement, fallback policy gotcha), database coexistence (shared connection + per-module schemas, or per-module connection strings), and frontend integration (skipping Inertia/React entirely for API-only hosts).
  • A "common pitfalls" section for the issues most likely to bite during integration.

The guide is grounded in the actual public API surface — builder.AddSimpleModule() / await app.UseSimpleModule(), generator analyzer reference shape, Database config section, fallback RequireAuthenticatedUser policy — so the snippets are copy-pasteable.

Files changed

  • docs/site/getting-started/brownfield-integration.md — new page (~360 lines).
  • docs/site/.vitepress/config.ts — sidebar entry added under Getting Started.

Test plan

  • npm run docs:dev (or local VitePress preview) — new page renders, sidebar entry appears under Getting Started.
  • Internal links resolve: /getting-started/quick-start, /guide/modules, /guide/endpoints, /guide/database, /advanced/source-generator.
  • Code snippets compile mentally against current Program.cs shape in template/SimpleModule.Host.

Generated by Claude Code

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 10, 2026

Deploying simplemodule-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2dbf327
Status: ✅  Deploy successful!
Preview URL: https://a2a803cc.simplemodule-website.pages.dev
Branch Preview URL: https://claude-dotnet-integration-gu.simplemodule-website.pages.dev

View logs

@antosubash antosubash marked this pull request as ready for review May 10, 2026 21:04
@antosubash antosubash enabled auto-merge (squash) May 10, 2026 21:04
@antosubash antosubash disabled auto-merge May 10, 2026 21:05
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