Meet Patel commited on
Commit
ecc3905
Β·
1 Parent(s): 22f81ff

Relocate documentation files to docs/ directory and update README

Browse files

- Move ARCHITECTURE.md, CODE_OF_CONDUCT.md, and PROJECT_ANALYSIS.md from root to docs/ directory
- Update README.md to reflect new documentation locations
- Make corresponding changes in app.py to handle new file paths
- Maintain all existing documentation content while reorganizing project structure

This reorganization improves project structure by keeping all documentation files in a dedicated directory, making the root cleaner while maintaining accessibility.

README.md CHANGED
@@ -18,6 +18,20 @@ A comprehensive Model Context Protocol (MCP) server for educational AI tutoring
18
 
19
  TutorX-MCP is an adaptive, multi-modal, and collaborative AI tutoring platform that leverages the Model Context Protocol (MCP) for tool integration and Gradio for user-friendly interfaces. It provides a range of educational features accessible via both MCP clients and a dedicated web interface.
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  ## ✨ New: Enhanced AI Integration & Capabilities
22
 
23
  **πŸ€– Contextualized AI Tutoring:**
@@ -32,9 +46,8 @@ TutorX-MCP is an adaptive, multi-modal, and collaborative AI tutoring platform t
32
  - **Gamified content** with game mechanics and progressive difficulty
33
  - **Multi-modal content** supporting different learning styles
34
 
35
- ![TutorX-MCP](https://via.placeholder.com/800x400?text=TutorX-MCP+Educational+Platform)
36
 
37
- For a comprehensive analysis of the project from architectural, development, and product perspectives, please see our [Project Analysis Document](PROJECT_ANALYSIS.md).
38
 
39
  ## Version History
40
 
@@ -291,7 +304,7 @@ This separation of concerns allows:
291
  - Clear boundaries between presentation, API gateway, tool implementations, and resources
292
  - Easy extension through the addition of new tool modules
293
 
294
- For more detailed architecture information, see the [Architecture Documentation](ARCHITECTURE.md) and [Project Analysis](PROJECT_ANALYSIS.md).
295
 
296
  ## Testing
297
 
@@ -307,12 +320,10 @@ python run_tests.py
307
 
308
  ## Documentation
309
 
310
- - [Project Analysis](PROJECT_ANALYSIS.md): Comprehensive analysis of architecture, implementation, and product features
311
  - [AI Integration Features](docs/AI_INTEGRATION_FEATURES.md): ✨ **NEW** - Detailed guide to contextualized AI tutoring and content generation
312
  - [MCP Protocol](docs/mcp.md): Details about the Model Context Protocol
313
  - [Product Requirements](docs/prd.md): Original requirements document
314
  - [SDK Documentation](docs/sdk.md): Client SDK usage
315
- - [Architecture](ARCHITECTURE.md): Detailed technical architecture documentation
316
 
317
  ## Contributing
318
 
 
18
 
19
  TutorX-MCP is an adaptive, multi-modal, and collaborative AI tutoring platform that leverages the Model Context Protocol (MCP) for tool integration and Gradio for user-friendly interfaces. It provides a range of educational features accessible via both MCP clients and a dedicated web interface.
20
 
21
+ ## Additional Documentation
22
+
23
+ Beyond this README, the TutorX project is accompanied by a suite of detailed documentation files, each offering deeper insights into specific aspects of the platform.
24
+
25
+ - **[CODE_OF_CONDUCT.md](docs/CODE_OF_CONDUCT.md)**: Outlines the standards for behavior within the TutorX community.
26
+ - **[UI_UX_IMPROVEMENTS_SUMMARY.md](docs/UI_UX_IMPROVEMENTS_SUMMARY.md)**: Summarizes improvements made to the user interface and user experience.
27
+ - **[UI_UX_ENHANCEMENTS.md](docs/UI_UX_ENHANCEMENTS.md)**: Details specific enhancements implemented for the UI/UX.
28
+ - **[NEW_ADAPTIVE_LEARNING_README.md](docs/NEW_ADAPTIVE_LEARNING_README.md)**: Introduces new features and updates related to the adaptive learning system.
29
+ - **[GRADIO_THEME_COLOR_FIXES.md](docs/GRADIO_THEME_COLOR_FIXES.md)**: Documents fixes and adjustments made to the Gradio theme and colors.
30
+ - **[FIXES_SUMMARY.md](docs/FIXES_SUMMARY.md)**: A summary of various bug fixes and resolved issues.
31
+ - **[ENHANCED_ADAPTIVE_LEARNING_GEMINI.md](docs/ENHANCED_ADAPTIVE_LEARNING_GEMINI.md)**: Explores the enhancements to the adaptive learning system through Gemini integration.
32
+ - **[AI_INTEGRATION_FEATURES.md](docs/AI_INTEGRATION_FEATURES.md)**: Details the features and capabilities related to AI integration within the platform.
33
+
34
+
35
  ## ✨ New: Enhanced AI Integration & Capabilities
36
 
37
  **πŸ€– Contextualized AI Tutoring:**
 
46
  - **Gamified content** with game mechanics and progressive difficulty
47
  - **Multi-modal content** supporting different learning styles
48
 
49
+ [TutorX-MCP]
50
 
 
51
 
52
  ## Version History
53
 
 
304
  - Clear boundaries between presentation, API gateway, tool implementations, and resources
305
  - Easy extension through the addition of new tool modules
306
 
307
+ For more detailed architecture information, see the documentation in the docs/ folder.
308
 
309
  ## Testing
310
 
 
320
 
321
  ## Documentation
322
 
 
323
  - [AI Integration Features](docs/AI_INTEGRATION_FEATURES.md): ✨ **NEW** - Detailed guide to contextualized AI tutoring and content generation
324
  - [MCP Protocol](docs/mcp.md): Details about the Model Context Protocol
325
  - [Product Requirements](docs/prd.md): Original requirements document
326
  - [SDK Documentation](docs/sdk.md): Client SDK usage
 
327
 
328
  ## Contributing
329
 
app.py CHANGED
@@ -21,7 +21,7 @@ from mcp.client.sse import sse_client
21
  from mcp.client.session import ClientSession
22
 
23
  # Server configuration
24
- # SERVER_URL = "http://localhost:8000" # Ensure this is the SSE endpoint
25
  SERVER_URL = "https://tutorx-mcp.onrender.com/sse"
26
  # Utility functions
27
 
 
21
  from mcp.client.session import ClientSession
22
 
23
  # Server configuration
24
+ # SERVER_URL = "http://localhost:8000/sse" # Ensure this is the SSE endpoint
25
  SERVER_URL = "https://tutorx-mcp.onrender.com/sse"
26
  # Utility functions
27
 
ARCHITECTURE.md β†’ docs/ARCHITECTURE.md RENAMED
File without changes
CODE_OF_CONDUCT.md β†’ docs/CODE_OF_CONDUCT.md RENAMED
File without changes
PROJECT_ANALYSIS.md β†’ docs/PROJECT_ANALYSIS.md RENAMED
File without changes