docs: modernize README structure and documentation

[nanotaboada]

• Add Tech Stack table with GitHub links
• Add Project Structure with annotated file tree
• Replace SVG with Mermaid architecture diagram (4-color scheme)
• Split Environment Variables by context (local vs Docker)
• Add Command Summary table
• Remove redundant content and fix inconsistencies

Summary by CodeRabbit

• Documentation
  • Completely restructured README with comprehensive Tech Stack, Architecture, and API Reference sections
  • Added visual diagrams for project structure and system architecture
  • Enhanced Docker deployment documentation with database reset guidance
  • Expanded environment configuration and command reference documentation
  • Introduced formal Contributing guidelines for developers

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The README.md is comprehensively restructured, replacing basic sections with detailed documentation including tech stack overview, project structure diagram, architecture explanation with Mermaid diagram, expanded API reference, Docker procedures, environment variables, command summary, and contributing guidelines.

Changes

Cohort / File(s)	Summary
Documentation Restructure README.md	Complete overhaul of README with new sections: table-of-contents, Tech Stack table, Project Structure diagram, Architecture section with Mermaid diagram, expanded API Reference with Swagger reference, Docker procedures, Environment Variables, Command Summary, and Contributing guidelines. Replaces Status, About, Structure, Start, Documentation, Credits, and Terms sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify accuracy of Tech Stack table entries and framework versions
• Confirm Project Structure diagrams and file paths match actual repository layout
• Review Architecture section and Mermaid diagram for technical correctness
• Validate API endpoint references align with actual implementation
• Check Environment Variables section for completeness and correctness of configuration options
• Ensure Docker documentation accurately reflects first-run and subsequent-run behavior

Pre-merge checks and finishing touches

✅ 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 'docs: modernize README structure and documentation' directly aligns with the main change—a comprehensive README overhaul. It clearly communicates the primary objective of modernizing and restructuring documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/enhance-README

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00%	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (eb2bd00)	1152	196	17.01%
Head commit (2b3b9ff)	1152 (+0)	196 (+0)	17.01% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#312)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

61-94: Specify language for the fenced code block.

The project structure code block should declare a language identifier for proper markdown rendering and linting compliance.

Apply this fix:

-```
+```text
 src/Dotnet.Samples.AspNetCore.WebApi/

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb2bd00 and 2b3b9ff.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~296-~296: The official name of this software platform is spelled with a capital “H”.
Context: ...ep changes small and focused - Review [.github/copilot-instructions.md](.github/copilo...

(GITHUB)

---

[uncategorized] ~296-~296: The official name of this software platform is spelled with a capital “H”.
Context: ... Review .github/copilot-instructions.md for architectu...

(GITHUB)

🪛 markdownlint-cli2 (0.18.1)

README.md

61-61: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: coverage (codecov)
• GitHub Check: coverage (codacy)
• GitHub Check: Codacy Static Code Analysis
• GitHub Check: Analyze (csharp)