Skip to content

Commit ab34b71

Browse files
committed
Add comprehensive documentation for project structure, Pydantic architecture, quick start guide, troubleshooting, and unified architecture
- Created PROJECT_STRUCTURE.md detailing the organization of backend, frontend, tests, and documentation files. - Introduced PYDANTIC_ARCHITECTURE.md explaining the use of Pydantic for type safety, schema generation, and validation in the backend. - Added QUICKSTART.md for easy setup instructions to run the application in under 5 minutes. - Developed TROUBLESHOOTING.md to address common issues encountered during setup and development. - Established UNIFIED_ARCHITECTURE.md to describe the zero-duplication approach for REST and MCP integration using shared metadata. Signed-off-by: Andre Bossard <anbossar@microsoft.com>
1 parent 7e5d604 commit ab34b71

7 files changed

Lines changed: 28 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@
1313
- Frontend: React 18, Vite, FluentUI components, feature-first structure under `frontend/src/features`
1414
- Tests: Playwright E2E (`tests/e2e/app.spec.js`)
1515

16+
## Documentation
17+
18+
All deep-dive guides now live under `docs/` for easier discovery:
19+
20+
- [Quick Start](docs/QUICKSTART.md) – fastest path from clone to running servers
21+
- [Learning Guide](docs/LEARNING.md) – principles behind the architecture and code style
22+
- [Project Structure](docs/PROJECT_STRUCTURE.md) – file-by-file overview of the repo
23+
- [Pydantic Architecture](docs/PYDANTIC_ARCHITECTURE.md) – how models, validation, and operations fit together
24+
- [Unified Architecture](docs/UNIFIED_ARCHITECTURE.md) – REST + MCP integration details and extension ideas
25+
- [Troubleshooting](docs/TROUBLESHOOTING.md) – common issues and fixes for setup, dev, and tests
26+
27+
1628
## 5-minute quick start (TL;DR)
1729
1. Clone the repo: `git clone <your-fork-url> && cd python-quart-vite-react`
1830
2. Run the automated bootstrap: `./setup.sh` (creates the backend venv, installs frontend deps, installs Playwright)
File renamed without changes.
Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,14 @@ python-quart-vite-react/
5555
├── setup.sh # Automated setup script
5656
├── start-dev.sh # Development server launcher
5757
58-
├── README.md # Main documentation
59-
├── QUICKSTART.md # Quick start guide
60-
├── LEARNING.md # Learning guide and principles
61-
└── PROJECT_STRUCTURE.md # This file
58+
├── docs/ # Supplemental documentation
59+
│ ├── LEARNING.md # Learning guide and principles
60+
│ ├── PROJECT_STRUCTURE.md # This file
61+
│ ├── PYDANTIC_ARCHITECTURE.md # Deep dive into Pydantic models
62+
│ ├── QUICKSTART.md # Quick start guide
63+
│ ├── TROUBLESHOOTING.md # Common issues and fixes
64+
│ └── UNIFIED_ARCHITECTURE.md # REST + MCP architecture guide
65+
└── README.md # Main documentation
6266
```
6367

6468
## File Purposes
@@ -111,10 +115,13 @@ python-quart-vite-react/
111115

112116
| File | Purpose |
113117
|------|---------|
114-
| `README.md` | Complete documentation with setup instructions |
118+
| `../README.md` | Complete documentation with setup instructions |
115119
| `QUICKSTART.md` | Fast setup guide for quick start |
116120
| `LEARNING.md` | Explains code principles and patterns |
117121
| `PROJECT_STRUCTURE.md` | This file - project organization |
122+
| `PYDANTIC_ARCHITECTURE.md` | Deep dive into Pydantic models and validation |
123+
| `UNIFIED_ARCHITECTURE.md` | Unified REST + MCP architecture reference |
124+
| `TROUBLESHOOTING.md` | Common setup, dev, and test fixes |
118125

119126
### Scripts
120127

@@ -230,6 +237,6 @@ If a file grows beyond these guidelines, consider splitting it into smaller modu
230237
## Questions?
231238

232239
Refer to:
233-
- [README.md](README.md) for setup and running
240+
- [README.md](../README.md) for setup and running
234241
- [QUICKSTART.md](QUICKSTART.md) for fast setup
235242
- [LEARNING.md](LEARNING.md) for understanding the code principles
File renamed without changes.

QUICKSTART.md renamed to docs/QUICKSTART.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ npm install
105105

106106
## Next Steps
107107

108-
- Read the full [README.md](README.md) for detailed documentation
108+
- Read the full [README.md](../README.md) for detailed documentation
109109
- Run tests: `npm run test:e2e:ui`
110110
- Explore the code and try modifying it!
111111

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ test('my test', async ({ page }) => {
487487
488488
### Get More Help
489489
490-
1. Read the full [README.md](README.md)
490+
1. Read the full [README.md](../README.md)
491491
2. Check [LEARNING.md](LEARNING.md) for code explanations
492492
3. Review [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) for file locations
493493
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,4 +310,4 @@ All without duplicating business logic or metadata!
310310
- See [app.py](backend/app.py) for the implementation
311311
- See [api_decorators.py](backend/api_decorators.py) for the decorator system
312312
- See [tasks/service.py](backend/tasks/service.py) for business logic
313-
- See [README.md](README.md) for usage instructions
313+
- See [README.md](../README.md) for usage instructions

0 commit comments

Comments
 (0)