Repository navigation
docs: overhaul README as demo-first, move reference detail into docs/ - #149
Merged
Merged
Conversation
Restructures README.md around the live demo and a grouped feature list, adds a package-ecosystem diagram and a recorded auth-flow GIF, and moves JWT/notification/database configuration, the customization table, and upgrade notes into docs/CONFIGURATION.md, docs/CUSTOMIZING.md, and docs/UPGRADING.md. docs/LOCAL_DEV.md gains the native/hot-reload setup, end-to-end suite instructions, and project structure previously in the README. CONTRIBUTING.md and docs/DEPLOYMENT.md's cross-references are updated to match.
Restores the Prerequisites and EF Core/MySQL facts dropped in the move to docs/, adds the Jwt2Fa -> NotificationProviders edge to the ecosystem diagram, links Deploy your own's step 6 to the variables it needs, marks README.md itself as a TODO(template) customization point, fixes the demo callout's doubled punctuation, updates the GIF alt text to match its content, and trims a blank leading frame from the GIF.
Wraps the Angular client and .NET API in a labeled subgraph so the diagram visually separates this repo from the extracted packages it depends on.
|
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
#how-to-use-this-template,#jwt-configuration, and#database-providerat their original locations for external linksTest plan
YOUR_PROJECT_IDplaceholder)#running-the-template-as-is,#run-with-docker,#backend-setup,#notification-senders,#upgrading-angular,#options,#upgrading,#prerequisites,#technology-stack,#features,#customizing-for-your-project): zero hits on GitHub code search for any of the 11; the dev.to writeup's only fragment link into this repo is an unrelated page-navigation anchor; all 5 sibling-repo READMEs (Jwt2Fa, NotificationProviders, dgates-mock-servers, AwsSecretsManager, dotnet-nuget-release-template) checked directly — one plain (fragment-free) repo link in dgates-mock-servers, no anchor links found anywhere