mirror of
https://github.com/johndoe6345789/tustu.git
synced 2026-04-24 13:45:00 +00:00
johndoe6345789
89317fbc21
- Deleted `IMPLEMENTATION_SUMMARY.md` as its content is now integrated into other documentation. - Added `INDEX.md` for quick navigation of the scripts folder. - Created `MARKDOWN_STYLE.md` to establish a consistent markdown style guide for documentation. - Updated `README.md` to reflect the new documentation structure and provide links to additional resources. - Introduced `README_SCRIPTS.md` detailing the consolidation of scripts into `tustu_tools.py`. - Added `REORGANIZATION_SUMMARY.md` to summarize the changes made during the scripts reorganization. - Removed `TEST_DATA_GENERATOR_FEATURE.md` as its content is now covered in `README_SCRIPTS.md`. - Updated `scripts/README.md` to include links to new documentation files and improve clarity.
27 lines
964 B
Markdown
27 lines
964 B
Markdown
# Additional Documentation
|
|
|
|
This folder contains supplementary documentation for the scripts folder.
|
|
|
|
## Files
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| **INDEX.md** | Quick navigation index for all documentation |
|
|
| **README_SCRIPTS.md** | Detailed migration guide from individual scripts |
|
|
| **REORGANIZATION_SUMMARY.md** | Summary of folder reorganization |
|
|
| **MARKDOWN_STYLE.md** | Markdown style guide for documentation |
|
|
|
|
## Main Documentation
|
|
|
|
For everyday use, refer to the main documentation:
|
|
|
|
- **[../README.md](../README.md)** - Scripts folder overview
|
|
- **[../TUSTU_TOOLS_README.md](../TUSTU_TOOLS_README.md)** - Complete tool reference
|
|
|
|
## When to Read These Files
|
|
|
|
- **New contributors** - Read MARKDOWN_STYLE.md for documentation standards
|
|
- **Migrating code** - Read README_SCRIPTS.md for detailed migration info
|
|
- **Understanding history** - Read REORGANIZATION_SUMMARY.md for context
|
|
- **Quick navigation** - Use INDEX.md to find specific topics
|