Skip to content

Documentation Index

Jump to bottom
Arte edited this page Jan 25, 2026 · 2 revisions

Documentation Index

Complete reference of all documentation files in this project.

📚 Documentation Files

README Files

File Purpose
README.md Project overview, quick start, FAQ
DOCS_INDEX.md Documentation index and quick reference

Guides in /docs Folder

File Audience Key Topics
Getting-Started.md New Users Installation, build, run, first interaction
Architecture.md Developers System design, components, data flow
Testing.md Test Writers Test suite, writing tests, best practices
WORKFLOW.md All Developers Development workflow, branching, CI/CD pipeline
QUALITY_TRANSLATION_GUIDE.md Security-focused Quality scoring, multi-language support, 24-hour uptime
WORKFLOW_PROTOCOL.md All Developers Development workflow, CI/CD, deployment, Docker
TRANSLATOR_FEATURE.md All Users Translator module, language support, usage
TRANSLATION_DATABASE.md Database Users Translation storage, rule management, quality tracking
CODE_REPOSITORY.md Code Reviewers Code storage, review workflows, quality scoring
Instruction-Wiki.md All Users Core architecture, interfaces, implementation
../INSTRUCTION_TRANSLATION_GUIDE.md All Users Protocol-aligned instruction translation, hierarchical processing
Wiki-Home.md Wiki Visitors Navigation, overview, quick links
Wiki-Setup.md Wiki Admins Wiki setup, synchronization, management
Foreign-Education.md Int'l Educators Adaptation for foreign education systems

Contributing & Policy

File Purpose
CONTRIBUTING.md Contribution guidelines, workflow, code style
DISTRIBUTION_POLICY.md Distribution, commercial use, licensing
LICENSE MIT License

🎯 Quick Navigation by Role

👤 I'm a New User

  1. Start with: README.md — Overview & quick start
  2. Then read: Getting-Started.md — Installation guide
  3. Try it: dotnet run --project DeepLearningProtocol/DeepLearningProtocol.csproj

👨‍💻 I'm a Developer

  1. Read: Architecture.md — System design
  2. Study: Program.cs — Implementation
  3. Learn: WORKFLOW.md — Development workflow & branching strategy
  4. Learn: WORKFLOW_PROTOCOL.md — CI/CD & deployment workflow
  5. Learn: QUALITY_TRANSLATION_GUIDE.md — QT system
  6. Test: Testing.md — Test suite

🐳 I Want to Deploy with Docker

  1. Read: WORKFLOW_PROTOCOL.md — Docker setup
  2. Build: docker build -t deeplearningprotocol:latest .
  3. Run: docker run -it deeplearningprotocol:latest

🧪 I Want to Write Tests

  1. Read: Testing.md — Test guide
  2. Understand: Architecture.md — What to test
  3. Follow: Examples in DeepLearningProtocolTests.cs
  4. Run: dotnet test

🤝 I Want to Contribute

  1. Read: CONTRIBUTING.md — Contribution guidelines
  2. Follow: Development workflow
  3. Study: Code Style Guide
  4. Test: Testing Requirements

📖 I'm Setting Up the Wiki

  1. Read: Wiki-Setup.md — Complete setup guide
  2. Follow: Setup process
  3. Use: Wiki-Home.md — Home page template

🛡️ I'm Learning About Quality Translation & Security

  1. Read: QUALITY_TRANSLATION_GUIDE.md — Comprehensive guide
  2. Understand: Quality Scoring — Assessment system
  3. Learn: Multi-language Support — Supported languages

� Quick Links

Getting Started

Core Documentation

Development

Wiki & Wiki Setup

📚 Documentation by Type

Entry Points:

Learning Paths:

  • Developers: Architecture.md → WORKFLOW_PROTOCOL.md → Testing.md
  • Users: Getting-Started.md → DLP-Guide.md → Architecture.md
  • Contributors: CONTRIBUTING.md → Testing.md → WORKFLOW_PROTOCOL.md

Reference:

🚀 Quick Commands

View documentation files:

# Terminal
cat README.md
cat docs/Getting-Started.md
cat docs/Architecture.md

# VS Code
code README.md
code docs/

Last Updated: January 25, 2026
Status: Current and maintained
Maintained by: @quickattach0-tech du -sh docs/*.md


### Search Documentation
```bash

Clone this wiki locally