[NET-14] Document Phase 1 migration and knowledge transfer#21
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
[NET-14] Document Phase 1 migration and knowledge transfer#21devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Adds top-level docs/ covering the migration patterns, configuration migration, troubleshooting, developer onboarding, code-review guidelines, development workflow, and the Phase 1 training agenda. Decisions assumed (called out in the PR for review): - Target framework: .NET 6 (per epic NET-1) - Repo layout: netcore/ alongside the legacy app (Strangler Fig) - Docs home: top-level docs/ that references netcore/docs/ produced by NET-12 and NET-13 rather than duplicating Updates the root README with a banner pointing at docs/. Refs: NET-14
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
Adds the Phase 1 documentation set required by Jira ticket NET-14 — "Documentation and Knowledge Transfer for Phase 1 Migration". All new files live under a top-level
docs/folder and the rootREADME.mdis updated with a banner pointing at it.New documentation
docs/README.mddocs/Phase1-Migration-Guide.mddocs/Phase1-Configuration-Migration.mdWeb.config→appsettings.json, connection strings, typedIOptions<T>, log4net →ILogger, Autofac → built-in DI, NuGet package subset, static-asset path mappingdocs/Phase1-Troubleshooting.mddocs/Onboarding.mdnetcore/project tour, smoke-test checklistdocs/CodeReview-Guidelines.mddocs/Development-Workflow.mddocs/training/Phase1-Training-Agenda.mdDecisions assumed (please challenge in review)
These were open questions called out in the planning comment on NET-14. I picked defensible defaults so this PR isn't blocked; if the team disagrees, the docs are easy to amend.
netcore/at the repo root (the layout NET-12 and NET-13 already chose).docs/— referencesnetcore/docs/testing.mdandnetcore/docs/cicd.mdrather than duplicating them.master.What this PR is not
SampleWebApp/,BizLayer/,DataLayer/,ServiceLayer/,Tests/, ornetcore/. Documentation only.master, it is being produced on the corresponding feature branch".Review & Testing Checklist for Human
Risk: green (docs-only, zero runtime impact). 3 items to confirm:
netcore/should be renamed (e.g. tosrc/orSampleWebApp.Core/), say so — find/replace across the docs is cheap.netcore/docs/testing.mdandnetcore/docs/cicd.mdwill resolve correctly once NET-12 and NET-13 merge. (Today they're still on feature branches, which is explicitly called out indocs/README.md.)docs/Phase1-Migration-Guide.mdanddocs/Phase1-Configuration-Migration.md) for accuracy against your own mental model of the migration.Notes
docs/training/Phase1-Training-Agenda.md.masteryet (NET-13 introduces them), so this PR will not run a build. That's expected.Link to Devin session: https://app.devin.ai/sessions/dd09732f78f6403984b3c6a45865f102
Devin Review