Spaces:
Running
Running
docs: Remove `docs/` and `../` prefixes from internal links across documentation files.
Browse files- docs/HUGGINGFACE_SPACES_GUIDE.md +3 -3
- docs/HUGGINGFACE_SPACES_SETUP.md +3 -3
- docs/README_ENHANCED.md +4 -6
- docs/SETUP_GUIDES_OVERVIEW.md +2 -2
- docs/START_HERE.md +11 -12
docs/HUGGINGFACE_SPACES_GUIDE.md
CHANGED
|
@@ -114,9 +114,9 @@ python3 run_ui.py
|
|
| 114 |
|
| 115 |
## Documentation
|
| 116 |
|
| 117 |
-
- [Quick Start](
|
| 118 |
-
- [Architecture](
|
| 119 |
-
- [Developer Guide](
|
| 120 |
|
| 121 |
## Support
|
| 122 |
|
|
|
|
| 114 |
|
| 115 |
## Documentation
|
| 116 |
|
| 117 |
+
- [Quick Start](QUICK_START.md)
|
| 118 |
+
- [Architecture](STRUCTURE.md)
|
| 119 |
+
- [Developer Guide](DEVELOPER_GUIDE.md)
|
| 120 |
|
| 121 |
## Support
|
| 122 |
|
docs/HUGGINGFACE_SPACES_SETUP.md
CHANGED
|
@@ -197,9 +197,9 @@ Each tool is fully compliant with MCP specification:
|
|
| 197 |
|
| 198 |
## Documentation
|
| 199 |
|
| 200 |
-
- [Quick Start Guide](
|
| 201 |
-
- [Developer Guide](
|
| 202 |
-
- [Project Structure](
|
| 203 |
|
| 204 |
## Architecture
|
| 205 |
|
|
|
|
| 197 |
|
| 198 |
## Documentation
|
| 199 |
|
| 200 |
+
- [Quick Start Guide](QUICK_START.md) - Get running in 2 minutes
|
| 201 |
+
- [Developer Guide](DEVELOPER_GUIDE.md) - Complete architecture
|
| 202 |
+
- [Project Structure](STRUCTURE.md) - Code organization
|
| 203 |
|
| 204 |
## Architecture
|
| 205 |
|
docs/README_ENHANCED.md
CHANGED
|
@@ -276,18 +276,16 @@ Edit `~/.config/Claude/claude_desktop_config.json`:
|
|
| 276 |
## Documentation
|
| 277 |
|
| 278 |
### User Guide
|
| 279 |
-
- [Gradio Interface Usage](./docs/usage.md)
|
| 280 |
- [Claude Desktop Setup](./CLAUDE_DESKTOP_SETUP.md)
|
| 281 |
- [Deployment Guide](./DEPLOYMENT_GUIDE.md)
|
| 282 |
|
| 283 |
### Technical Documentation
|
| 284 |
-
- [MCP Server Implementation](./
|
| 285 |
-
- [
|
| 286 |
-
- [API Reference](./docs/api.md)
|
| 287 |
|
| 288 |
### Development
|
| 289 |
-
- [
|
| 290 |
-
- [
|
| 291 |
|
| 292 |
---
|
| 293 |
|
|
|
|
| 276 |
## Documentation
|
| 277 |
|
| 278 |
### User Guide
|
|
|
|
| 279 |
- [Claude Desktop Setup](./CLAUDE_DESKTOP_SETUP.md)
|
| 280 |
- [Deployment Guide](./DEPLOYMENT_GUIDE.md)
|
| 281 |
|
| 282 |
### Technical Documentation
|
| 283 |
+
- [MCP Server Implementation](./implementation.md)
|
| 284 |
+
- [Project Structure](./STRUCTURE.md)
|
|
|
|
| 285 |
|
| 286 |
### Development
|
| 287 |
+
- [Developer Guide](./DEVELOPER_GUIDE.md)
|
| 288 |
+
- [Quick Start Guide](./QUICK_START.md)
|
| 289 |
|
| 290 |
---
|
| 291 |
|
docs/SETUP_GUIDES_OVERVIEW.md
CHANGED
|
@@ -9,13 +9,13 @@
|
|
| 9 |
Choose based on your current task:
|
| 10 |
|
| 11 |
### I'm starting fresh
|
| 12 |
-
Start with [QUICK_REFERENCE.md](
|
| 13 |
|
| 14 |
### I'm deploying to HuggingFace Spaces
|
| 15 |
Read [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) (10 mins)
|
| 16 |
|
| 17 |
### I'm preparing for hackathon submission
|
| 18 |
-
Use [HACKATHON_SUBMISSION_CHECKLIST.md](
|
| 19 |
|
| 20 |
### I want detailed HF Spaces reference
|
| 21 |
Check [HUGGINGFACE_SPACES_SETUP.md](HUGGINGFACE_SPACES_SETUP.md) (15 mins)
|
|
|
|
| 9 |
Choose based on your current task:
|
| 10 |
|
| 11 |
### I'm starting fresh
|
| 12 |
+
Start with [QUICK_REFERENCE.md](QUICK_REFERENCE.md) (2 mins)
|
| 13 |
|
| 14 |
### I'm deploying to HuggingFace Spaces
|
| 15 |
Read [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) (10 mins)
|
| 16 |
|
| 17 |
### I'm preparing for hackathon submission
|
| 18 |
+
Use [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md) (5 mins review)
|
| 19 |
|
| 20 |
### I want detailed HF Spaces reference
|
| 21 |
Check [HUGGINGFACE_SPACES_SETUP.md](HUGGINGFACE_SPACES_SETUP.md) (15 mins)
|
docs/START_HERE.md
CHANGED
|
@@ -17,7 +17,7 @@ Key facts, deploy commands, quick fixes, all essentials.
|
|
| 17 |
Want to deploy to HuggingFace Spaces right now?
|
| 18 |
|
| 19 |
1. Read: [QUICK_REFERENCE.md](QUICK_REFERENCE.md) (2 min)
|
| 20 |
-
2. Follow: [
|
| 21 |
3. Verify: Checklist at bottom of deployment guide
|
| 22 |
4. Done! Your Space is live π
|
| 23 |
|
|
@@ -28,7 +28,7 @@ Want to deploy to HuggingFace Spaces right now?
|
|
| 28 |
Want to submit to the hackathon?
|
| 29 |
|
| 30 |
**Timeline:**
|
| 31 |
-
- Deployment (15 min) β [
|
| 32 |
- Demo video (10 min) β Record yourself using the tool
|
| 33 |
- Social post (5 min) β Post on Twitter/LinkedIn
|
| 34 |
- Final check (5 min) β [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md)
|
|
@@ -49,25 +49,24 @@ See [GUIDE_MAP.txt](GUIDE_MAP.txt) β Visual decision tree
|
|
| 49 |
| Guide | Time | Purpose |
|
| 50 |
|-------|------|---------|
|
| 51 |
| [QUICK_REFERENCE.md](QUICK_REFERENCE.md) | 2 min | Fast facts, links, checklists |
|
| 52 |
-
| [
|
| 53 |
| [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md) | 5 min | Pre-submission checklist |
|
| 54 |
| [SPACE_README_TEMPLATE.md](SPACE_README_TEMPLATE.md) | 5 min | Copy for your Space README |
|
| 55 |
|
| 56 |
### Reference Guides
|
| 57 |
| Guide | Time | Purpose |
|
| 58 |
|-------|------|---------|
|
| 59 |
-
| [
|
| 60 |
-
| [
|
| 61 |
| [GUIDE_MAP.txt](GUIDE_MAP.txt) | 3 min | Visual map |
|
| 62 |
-
| [SETUP_SUMMARY.md](SETUP_SUMMARY.md) | 10 min | What was created |
|
| 63 |
|
| 64 |
### Developer Guides (Optional)
|
| 65 |
| Guide | Purpose |
|
| 66 |
|-------|---------|
|
| 67 |
-
| [
|
| 68 |
-
| [
|
| 69 |
-
| [
|
| 70 |
-
| [
|
| 71 |
|
| 72 |
---
|
| 73 |
|
|
@@ -149,7 +148,7 @@ After deploying, you need:
|
|
| 149 |
## π Something Went Wrong?
|
| 150 |
|
| 151 |
### "Module not found" error
|
| 152 |
-
β Check [
|
| 153 |
|
| 154 |
### OpenAI API error
|
| 155 |
β Verify API key in Repository secrets
|
|
@@ -168,7 +167,7 @@ You're reading the quick entry point.
|
|
| 168 |
|
| 169 |
### Next Steps:
|
| 170 |
- **Want quick facts?** β [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
| 171 |
-
- **Want to deploy?** β [
|
| 172 |
- **Want checklist?** β [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md)
|
| 173 |
- **Want full navigation?** β [GUIDE_MAP.txt](GUIDE_MAP.txt)
|
| 174 |
|
|
|
|
| 17 |
Want to deploy to HuggingFace Spaces right now?
|
| 18 |
|
| 19 |
1. Read: [QUICK_REFERENCE.md](QUICK_REFERENCE.md) (2 min)
|
| 20 |
+
2. Follow: [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) (10 min)
|
| 21 |
3. Verify: Checklist at bottom of deployment guide
|
| 22 |
4. Done! Your Space is live π
|
| 23 |
|
|
|
|
| 28 |
Want to submit to the hackathon?
|
| 29 |
|
| 30 |
**Timeline:**
|
| 31 |
+
- Deployment (15 min) β [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)
|
| 32 |
- Demo video (10 min) β Record yourself using the tool
|
| 33 |
- Social post (5 min) β Post on Twitter/LinkedIn
|
| 34 |
- Final check (5 min) β [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md)
|
|
|
|
| 49 |
| Guide | Time | Purpose |
|
| 50 |
|-------|------|---------|
|
| 51 |
| [QUICK_REFERENCE.md](QUICK_REFERENCE.md) | 2 min | Fast facts, links, checklists |
|
| 52 |
+
| [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) | 10 min | Deploy to HF Spaces |
|
| 53 |
| [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md) | 5 min | Pre-submission checklist |
|
| 54 |
| [SPACE_README_TEMPLATE.md](SPACE_README_TEMPLATE.md) | 5 min | Copy for your Space README |
|
| 55 |
|
| 56 |
### Reference Guides
|
| 57 |
| Guide | Time | Purpose |
|
| 58 |
|-------|------|---------|
|
| 59 |
+
| [HUGGINGFACE_SPACES_SETUP.md](HUGGINGFACE_SPACES_SETUP.md) | 15 min | Detailed HF reference |
|
| 60 |
+
| [SETUP_GUIDES_OVERVIEW.md](SETUP_GUIDES_OVERVIEW.md) | 5 min | Navigation hub |
|
| 61 |
| [GUIDE_MAP.txt](GUIDE_MAP.txt) | 3 min | Visual map |
|
|
|
|
| 62 |
|
| 63 |
### Developer Guides (Optional)
|
| 64 |
| Guide | Purpose |
|
| 65 |
|-------|---------|
|
| 66 |
+
| [DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md) | Architecture & development |
|
| 67 |
+
| [STRUCTURE.md](STRUCTURE.md) | Project file organization |
|
| 68 |
+
| [QUICK_START.md](QUICK_START.md) | Get running locally (2 min) |
|
| 69 |
+
| [CLAUDE_DESKTOP_SETUP.md](CLAUDE_DESKTOP_SETUP.md) | Claude Desktop integration |
|
| 70 |
|
| 71 |
---
|
| 72 |
|
|
|
|
| 148 |
## π Something Went Wrong?
|
| 149 |
|
| 150 |
### "Module not found" error
|
| 151 |
+
β Check [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) troubleshooting section
|
| 152 |
|
| 153 |
### OpenAI API error
|
| 154 |
β Verify API key in Repository secrets
|
|
|
|
| 167 |
|
| 168 |
### Next Steps:
|
| 169 |
- **Want quick facts?** β [QUICK_REFERENCE.md](QUICK_REFERENCE.md)
|
| 170 |
+
- **Want to deploy?** β [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)
|
| 171 |
- **Want checklist?** β [HACKATHON_SUBMISSION_CHECKLIST.md](HACKATHON_SUBMISSION_CHECKLIST.md)
|
| 172 |
- **Want full navigation?** β [GUIDE_MAP.txt](GUIDE_MAP.txt)
|
| 173 |
|