Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
guides
guides
 
 
wiki
wiki
 
 
README.md
README.md
 
 

README.md

VCTrain Documentation

Complete documentation for VCTrain - Enhanced RVC Training System with full TypeScript stack.

📚 Documentation Structure

docs/
├── wiki/           # GitHub Wiki pages (for github.com/wiki)
│   ├── Home.md
│   ├── Installation-Guide.md
│   ├── First-Training.md
│   ├── Colab-Setup.md
│   └── Architecture.md
│
├── guides/         # Technical guides and references
│   ├── Quickstart.md
│   ├── TypeScript-Stack.md
│   ├── Frontend-Fix.md
│   ├── Reorganization.md
│   ├── Changes-Summary.md
│   ├── Implementation-Complete.md
│   └── Wiki-Upload.md
│
└── README.md       # This file

🚀 Quick Navigation

Getting Started

  • [[Home|wiki/Home.md]] - Main documentation hub
  • [[Installation Guide|wiki/Installation-Guide.md]] - Setup instructions
  • [[First Training|wiki/First-Training.md]] - Your first voice model
  • [[Quickstart|guides/Quickstart.md]] - Quick reference guide

Google Colab

  • [[Colab Setup|wiki/Colab-Setup.md]] - Free GPU training guide
  • [[Frontend Fix|guides/Frontend-Fix.md]] - Node.js 20 fix details

Technical Deep Dives

  • [[Architecture|wiki/Architecture.md]] - System architecture
  • [[TypeScript Stack|guides/TypeScript-Stack.md]] - Type safety details
  • [[Reorganization|guides/Reorganization.md]] - Project structure changes

Development

  • [[Changes Summary|guides/Changes-Summary.md]] - Recent changes
  • [[Implementation Complete|guides/Implementation-Complete.md]] - Feature completion
  • [[Wiki Upload|guides/Wiki-Upload.md]] - How to upload wiki to GitHub

📖 Wiki Pages

The wiki/ folder contains pages ready for GitHub Wiki:

File GitHub Wiki Title Description
Home.md Home Main landing page
Installation-Guide.md Installation-Guide Setup guide
First-Training.md First-Training First training tutorial
Colab-Setup.md Colab-Setup Google Colab guide
Architecture.md Architecture Technical architecture

Upload to GitHub Wiki

# Clone wiki repository
git clone https://github.com/BF667-IDLE/VCTrain.wiki.git
cd VCTrain.wiki

# Copy wiki pages
cp ../docs/wiki/*.md .

# Upload
git add .
git commit -m "Add wiki pages from docs folder"
git push

See [[Wiki Upload Guide|guides/Wiki-Upload.md]] for detailed instructions.

🎯 User Paths

New User Path

  1. Start at [[Home|wiki/Home.md]]
  2. Read [[Installation Guide|wiki/Installation-Guide.md]]
  3. Follow [[First Training|wiki/First-Training.md]]
  4. Try [[Colab Setup|wiki/Colab-Setup.md]] for free GPU

Developer Path

  1. Read [[Architecture|wiki/Architecture.md]]
  2. Study [[TypeScript Stack|guides/TypeScript-Stack.md]]
  3. Review [[Changes Summary|guides/Changes-Summary.md]]

Advanced User Path

  1. Check [[Quickstart|guides/Quickstart.md]]
  2. Read optimizer guides
  3. Explore [[Implementation Complete|guides/Implementation-Complete.md]]

📊 Documentation Status

Category Pages Status
Wiki Pages 5 ✅ Complete
Technical Guides 7 ✅ Complete
Total Pages 12 ✅ Complete

🔗 External Links

🤝 Contributing to Documentation

Found a typo or want to add more guides?

  1. Edit files in docs/ folder
  2. Submit a Pull Request
  3. Or upload to GitHub Wiki directly

Adding New Wiki Pages

# Create new wiki page in docs/wiki/
touch docs/wiki/Your-Topic.md

# Write content using Markdown
# See existing pages for formatting examples

# Commit and push
git add docs/wiki/Your-Topic.md
git commit -m "docs: Add Your Topic wiki page"
git push

📝 License

Documentation follows the same license as the VCTrain project.

Last Updated: April 12, 2026
Version: 0.4.1
Status: ✅ Production Ready