Hugging Face's logo

Spaces:
MCP-1st-Birthday
/
science-storyteller
Running

App Files Community
tuhulab commited on
Commit
28b3cfa
·
1 Parent(s): 91c6eed

chore: Organize repository structure - move docs to docs/ and tests to tests/

Browse files
Files changed (15) hide show
  1. CACHE_FIX_SUMMARY.md → docs/CACHE_FIX_SUMMARY.md +0 -0
  2. CACHING_GUIDE.md → docs/CACHING_GUIDE.md +0 -0
  3. IMPLEMENTATION_COMPLETE.md → docs/IMPLEMENTATION_COMPLETE.md +0 -0
  4. LEARNING_GUIDE.md → docs/LEARNING_GUIDE.md +0 -0
  5. LOCAL_TESTING.md → docs/LOCAL_TESTING.md +0 -0
  6. QUICKSTART.md → docs/QUICKSTART.md +0 -0
  7. docs/README.md +20 -0
  8. convert_cache_to_mp3.py → tests/convert_cache_to_mp3.py +0 -0
  9. generate_cache.py → tests/generate_cache.py +0 -0
  10. quick_test.py → tests/quick_test.py +0 -0
  11. test_cache.py → tests/test_cache.py +0 -0
  12. test_components.py → tests/test_components.py +0 -0
  13. test_full_workflow.py → tests/test_full_workflow.py +0 -0
  14. test_kokoro.py → tests/test_kokoro.py +0 -0
  15. test_scholar_direct.py → tests/test_scholar_direct.py +0 -0
CACHE_FIX_SUMMARY.md → docs/CACHE_FIX_SUMMARY.md RENAMED
File without changes
CACHING_GUIDE.md → docs/CACHING_GUIDE.md RENAMED
File without changes
IMPLEMENTATION_COMPLETE.md → docs/IMPLEMENTATION_COMPLETE.md RENAMED
File without changes
LEARNING_GUIDE.md → docs/LEARNING_GUIDE.md RENAMED
File without changes
LOCAL_TESTING.md → docs/LOCAL_TESTING.md RENAMED
File without changes
QUICKSTART.md → docs/QUICKSTART.md RENAMED
File without changes
docs/README.md ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Documentation
2
+
3
+ This directory contains detailed documentation for developers and contributors.
4
+
5
+ ## Documentation Files
6
+
7
+ - **[QUICKSTART.md](QUICKSTART.md)** - Quick start guide for getting the app running
8
+ - **[LEARNING_GUIDE.md](LEARNING_GUIDE.md)** - Learning resources and educational content
9
+ - **[CACHING_GUIDE.md](CACHING_GUIDE.md)** - Guide to the caching system and how it works
10
+ - **[LOCAL_TESTING.md](LOCAL_TESTING.md)** - Instructions for testing locally
11
+ - **[IMPLEMENTATION_COMPLETE.md](IMPLEMENTATION_COMPLETE.md)** - Implementation status and completion notes
12
+ - **[CACHE_FIX_SUMMARY.md](CACHE_FIX_SUMMARY.md)** - Summary of cache-related fixes and improvements
13
+
14
+ ## For Users
15
+
16
+ If you're just looking to use the app, please refer to the main [README.md](../README.md) in the project root.
17
+
18
+ ## For Developers
19
+
20
+ Start with the [QUICKSTART.md](QUICKSTART.md) to get your development environment set up, then explore the other guides as needed.
convert_cache_to_mp3.py → tests/convert_cache_to_mp3.py RENAMED
File without changes
generate_cache.py → tests/generate_cache.py RENAMED
File without changes
quick_test.py → tests/quick_test.py RENAMED
File without changes
test_cache.py → tests/test_cache.py RENAMED
File without changes
test_components.py → tests/test_components.py RENAMED
File without changes
test_full_workflow.py → tests/test_full_workflow.py RENAMED
File without changes
test_kokoro.py → tests/test_kokoro.py RENAMED
File without changes
test_scholar_direct.py → tests/test_scholar_direct.py RENAMED
File without changes