Skip to content

Commit e1e74b5

Browse files
adhit-radhit-r
committed
feat: enhance repository with comprehensive issue templates and stunning wiki pages
- Add 3 new specialized issue templates: * Convex Integration Issue - for database/auth problems * Lynx Frontend Issue - for cross-platform frontend issues * ML Backend Issue - for FastAPI/ML model problems * Documentation Issue - for docs/wiki problems * Performance Issue - for optimization needs - Create visually stunning wiki pages: * Home.md - comprehensive project overview with badges, stats, roadmap * Getting-Started.md - complete user guide with step-by-step instructions * Raga-Database.md - detailed raga information with detection statistics - Add professional styling with emojis, tables, and visual elements - Include comprehensive navigation and cross-references - Add performance metrics, learning resources, and interactive features
1 parent d4b6c68 commit e1e74b5

File tree

8 files changed

+1503
-177
lines changed

8 files changed

+1503
-177
lines changed

‎.github/ISSUE_TEMPLATE/convex_integration_issue.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: Convex Integration Issue
3+
about: Report issues with Convex database, authentication, or real-time features
4+
title: '[CONVEX] '
5+
labels: ['convex', 'database', 'authentication', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## Issue Description
10+
Describe the Convex-related problem you encountered.
11+
12+
## Issue Type
13+
- [ ] Database Schema Issue
14+
- [ ] Authentication Problem
15+
- [ ] Real-time Sync Issue
16+
- [ ] Query/Mutation Error
17+
- [ ] Performance Issue
18+
- [ ] Deployment Problem
19+
- [ ] Other
20+
21+
## Error Details
22+
If applicable, provide the error message or stack trace:
23+
24+
```javascript
25+
// Example error
26+
Error: ConvexError: Invalid argument
27+
at api.users.getCurrentUser (convex/users.ts:15:3)
28+
```
29+
30+
## Steps to Reproduce
31+
1. Navigate to '...'
32+
2. Perform action '...'
33+
3. Expected: '...'
34+
4. Actual: '...'
35+
36+
## Environment
37+
- **Platform**: [Web, iOS, Android]
38+
- **Browser**: [if applicable]
39+
- **Convex Environment**: [dev, prod]
40+
- **User Authentication**: [Logged in, Guest, Specific provider]
41+
42+
## Database Context
43+
- **Table**: [e.g. users, ragaDetections, files]
44+
- **Operation**: [Query, Mutation, Action]
45+
- **Data Size**: [e.g. Number of records affected]
46+
47+
## Authentication Context
48+
- **Auth Provider**: [Convex Auth, Google, GitHub, etc.]
49+
- **User State**: [Authenticated, Unauthenticated, Token expired]
50+
- **Permissions**: [Admin, User, Guest]
51+
52+
## Expected Behavior
53+
A clear description of what should happen.
54+
55+
## Actual Behavior
56+
A clear description of what actually happened.
57+
58+
## Screenshots/Logs
59+
If applicable, add screenshots or console logs.
60+
61+
## Additional Context
62+
- Is this happening for all users or specific users?
63+
- Does this happen consistently or intermittently?
64+
- Any recent changes to Convex functions or schema?
65+
66+
## Checklist
67+
- [ ] I have checked the Convex dashboard for errors
68+
- [ ] I have verified my authentication status
69+
- [ ] I have tested with different data
70+
- [ ] I have checked the browser console for errors
71+
- [ ] This is not a duplicate of an existing issue

‎.github/ISSUE_TEMPLATE/documentation_issue.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
name: Documentation Issue
3+
about: Report issues with documentation, wiki, or help content
4+
title: '[DOCS] '
5+
labels: ['documentation', 'wiki', 'help', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## Issue Description
10+
Describe the documentation problem you encountered.
11+
12+
## Issue Type
13+
- [ ] Missing Documentation
14+
- [ ] Outdated Information
15+
- [ ] Unclear Instructions
16+
- [ ] Broken Links
17+
- [ ] Grammar/Spelling Error
18+
- [ ] Code Example Issue
19+
- [ ] Screenshot/Image Problem
20+
- [ ] Wiki Page Issue
21+
- [ ] Other
22+
23+
## Documentation Location
24+
- [ ] README.md
25+
- [ ] Wiki Pages
26+
- [ ] API Documentation
27+
- [ ] Setup Guides
28+
- [ ] Code Comments
29+
- [ ] Inline Documentation
30+
- [ ] Other: _________
31+
32+
## Specific Location
33+
- **File/Page**: [e.g. docs/README.md, wiki/Getting-Started.md]
34+
- **Section**: [e.g. Installation, API Reference, Troubleshooting]
35+
- **Line Numbers**: [if applicable]
36+
37+
## Problem Description
38+
A clear description of what's wrong with the documentation.
39+
40+
## Expected Documentation
41+
What should the documentation say or show?
42+
43+
## Current Documentation
44+
What does it currently say or show?
45+
46+
## Impact
47+
- **User Impact**: How does this affect users?
48+
- **Developer Impact**: How does this affect developers?
49+
- **Priority**: [Low, Medium, High, Critical]
50+
51+
## Suggested Fix
52+
If you have a suggestion for how to fix it, describe it here.
53+
54+
## Additional Context
55+
- Is this affecting new users or experienced users?
56+
- Are there any related issues or discussions?
57+
- Any screenshots of the problematic documentation?
58+
59+
## Checklist
60+
- [ ] I have searched existing documentation
61+
- [ ] I have checked if this is already documented elsewhere
62+
- [ ] I have provided specific location details
63+
- [ ] I have suggested a fix (if possible)
64+
- [ ] This is not a duplicate of an existing issue

‎.github/ISSUE_TEMPLATE/lynx_frontend_issue.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
name: Lynx Frontend Issue
3+
about: Report issues with Lynx framework, ReactLynx components, or cross-platform functionality
4+
title: '[LYNX] '
5+
labels: ['lynx', 'frontend', 'react-lynx', 'cross-platform', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## Issue Description
10+
Describe the Lynx frontend problem you encountered.
11+
12+
## Issue Type
13+
- [ ] Component Rendering Issue
14+
- [ ] Cross-platform Compatibility
15+
- [ ] Build/Compilation Error
16+
- [ ] Performance Issue
17+
- [ ] Styling/Layout Problem
18+
- [ ] Navigation Issue
19+
- [ ] State Management
20+
- [ ] Platform-specific Bug
21+
- [ ] Other
22+
23+
## Platform(s) Affected
24+
- [ ] Web
25+
- [ ] iOS
26+
- [ ] Android
27+
- [ ] All platforms
28+
29+
## Error Details
30+
If applicable, provide the error message or stack trace:
31+
32+
```javascript
33+
// Example error
34+
Error: Cannot find module 'react-lynx'
35+
at Object.<anonymous> (src/components/RagaDetector.tsx:1:1)
36+
```
37+
38+
## Steps to Reproduce
39+
1. Open app on '...' platform
40+
2. Navigate to '...'
41+
3. Perform action '...'
42+
4. Expected: '...'
43+
5. Actual: '...'
44+
45+
## Environment
46+
- **Platform**: [Web, iOS, Android]
47+
- **Device**: [iPhone 14, Samsung Galaxy, Desktop, etc.]
48+
- **OS Version**: [iOS 17, Android 14, macOS, etc.]
49+
- **Browser**: [Chrome, Safari, Firefox] (if web)
50+
- **Lynx Version**: [e.g. 1.0.0]
51+
- **ReactLynx Version**: [e.g. 1.0.0]
52+
- **Rspeedy Version**: [e.g. 1.0.0]
53+
54+
## Component Details
55+
- **Component**: [e.g. RagaDetector, Navigation, etc.]
56+
- **File Path**: [e.g. src/components/RagaDetector.tsx]
57+
- **Props**: [if applicable]
58+
59+
## Build Information
60+
- **Build Command**: [e.g. `bun run build:web`]
61+
- **Build Output**: [any build errors or warnings]
62+
- **Development Server**: [e.g. `bun run dev`]
63+
64+
## Expected Behavior
65+
A clear description of what should happen.
66+
67+
## Actual Behavior
68+
A clear description of what actually happened.
69+
70+
## Screenshots/Video
71+
If applicable, add screenshots or screen recordings showing the issue.
72+
73+
## Console Logs
74+
If applicable, add browser console or development logs:
75+
76+
```javascript
77+
// Console output
78+
[Error] Failed to load component
79+
[Warning] StyleSheet.create warning
80+
```
81+
82+
## Additional Context
83+
- Does this happen on all devices of the same platform?
84+
- Is this a regression from a previous version?
85+
- Any recent changes to Lynx configuration?
86+
- Does this affect all users or specific scenarios?
87+
88+
## Reproduction Steps
89+
1. **Setup**: How to set up the environment to reproduce
90+
2. **Action**: Specific steps to trigger the issue
91+
3. **Result**: What happens vs what should happen
92+
93+
## Checklist
94+
- [ ] I have tested on multiple platforms (if applicable)
95+
- [ ] I have cleared cache and reinstalled dependencies
96+
- [ ] I have checked the Lynx documentation
97+
- [ ] I have verified my Lynx configuration
98+
- [ ] This is not a duplicate of an existing issue
99+
- [ ] I have provided all requested information

‎.github/ISSUE_TEMPLATE/ml_backend_issue.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
name: ML Backend Issue
3+
about: Report issues with FastAPI backend, ML model, or raga detection system
4+
title: '[ML-BACKEND] '
5+
labels: ['ml', 'backend', 'fastapi', 'raga-detection', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## Issue Description
10+
Describe the ML backend or FastAPI problem you encountered.
11+
12+
## Issue Type
13+
- [ ] Raga Detection Accuracy
14+
- [ ] Model Performance
15+
- [ ] API Endpoint Error
16+
- [ ] Audio Processing Issue
17+
- [ ] Feature Extraction Problem
18+
- [ ] Model Loading Error
19+
- [ ] Training Data Issue
20+
- [ ] Performance/Speed Issue
21+
- [ ] Other
22+
23+
## Error Details
24+
If applicable, provide the error message or stack trace:
25+
26+
```python
27+
# Example error
28+
Traceback (most recent call last):
29+
File "ml/working_raga_detector.py", line 45, in detect_raga
30+
features = extract_features(audio_file)
31+
ValueError: Audio file format not supported
32+
```
33+
34+
## API Endpoint
35+
- **Endpoint**: [e.g. POST /detect, GET /health]
36+
- **Request Method**: [GET, POST, PUT, DELETE]
37+
- **Request Body**: [if applicable]
38+
39+
## Audio File Information
40+
- **Format**: [WAV, MP3, OGG, FLAC, M4A]
41+
- **Duration**: [e.g. 30 seconds]
42+
- **Sample Rate**: [e.g. 22050 Hz]
43+
- **Channels**: [Mono, Stereo]
44+
- **File Size**: [e.g. 2.5 MB]
45+
- **Quality**: [High, Medium, Low]
46+
47+
## Detection Results
48+
If this is a detection accuracy issue:
49+
50+
**Expected Result:**
51+
```json
52+
{
53+
"predicted_raga": "Expected Raga",
54+
"confidence": 0.95,
55+
"processing_time": 0.06
56+
}
57+
```
58+
59+
**Actual Result:**
60+
```json
61+
{
62+
"predicted_raga": "Actual Raga",
63+
"confidence": 0.45,
64+
"processing_time": 0.06
65+
}
66+
```
67+
68+
## Environment
69+
- **Python Version**: [e.g. 3.9, 3.10, 3.11]
70+
- **FastAPI Version**: [e.g. 0.104.0]
71+
- **ML Libraries**: [TensorFlow, Librosa, Scikit-learn versions]
72+
- **OS**: [Windows, macOS, Linux]
73+
- **Backend URL**: [e.g. http://localhost:8000]
74+
75+
## Model Information
76+
- **Model Type**: [RandomForest, Neural Network, etc.]
77+
- **Model Version**: [e.g. v1.0.0]
78+
- **Training Data**: [Synthetic, Real, Mixed]
79+
- **Last Updated**: [Date]
80+
81+
## Steps to Reproduce
82+
1. Start backend server: `python -m backend.main`
83+
2. Send request to endpoint: `...`
84+
3. Expected: `...`
85+
4. Actual: `...`
86+
87+
## Performance Metrics
88+
- **Processing Time**: [e.g. 0.06 seconds]
89+
- **Memory Usage**: [if applicable]
90+
- **CPU Usage**: [if applicable]
91+
- **Response Time**: [API response time]
92+
93+
## Expected Behavior
94+
A clear description of what should happen.
95+
96+
## Actual Behavior
97+
A clear description of what actually happened.
98+
99+
## Logs
100+
If applicable, add backend logs:
101+
102+
```bash
103+
# Backend logs
104+
INFO: Started server process [12345]
105+
INFO: Waiting for application startup.
106+
INFO: Application startup complete.
107+
ERROR: Exception in ASGI application
108+
```
109+
110+
## Additional Context
111+
- Is this happening with all audio files or specific ones?
112+
- Does this happen consistently or intermittently?
113+
- Any recent changes to the ML model or backend?
114+
- Is this a regression from a previous version?
115+
116+
## Checklist
117+
- [ ] I have checked the backend logs
118+
- [ ] I have verified the audio file format is supported
119+
- [ ] I have tested with different audio files
120+
- [ ] I have confirmed the backend server is running
121+
- [ ] I have checked the ML model is loaded correctly
122+
- [ ] This is not a duplicate of an existing issue

0 commit comments

Comments
 (0)