Skip to content

feature(wzn): add language switcher and complete some Chinese docs#42

Merged
puyuan1996 merged 8 commits intoopendilab:mainfrom
zunian-wan:dev-docs
Mar 5, 2026
Merged

feature(wzn): add language switcher and complete some Chinese docs#42
puyuan1996 merged 8 commits intoopendilab:mainfrom
zunian-wan:dev-docs

Conversation

@zunian-wan
Copy link
Contributor

@zunian-wan zunian-wan commented Feb 10, 2026

📋 Summary

Add language switcher for en & zh in LightRFT docs and complete Chinese documentation for model testing, design philosophy, troubleshooting, and core project architecture.

Purpose:

Type of Change:

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🎨 Code refactoring (no functional changes)
  • ⚡ Performance improvement
  • ✅ Test addition/modification
  • 🔧 Configuration/Build changes

🔗 Related Issues

None

📝 Changes

What changed:

Why these changes:

Key implementation details:

🧪 Testing

Test Plan

  • Unit tests: Added/updated unit tests
  • Integration tests: Tested with full training pipeline
  • Manual testing: Describe what you tested manually

Test commands:

# Commands used to test the changes

Test Results

Test Output
Paste test output here

📊 Performance Impact

  • No performance impact
  • Performance improved:
  • Performance regression:

📚 Documentation

  • Docstrings updated for new/modified functions
  • README.md updated (if user-facing changes)
  • Documentation in docs/ updated (if applicable)
  • Examples updated/added (if applicable)
  • Configuration reference updated (if new parameters added)
  • CHANGELOG.md updated

✅ Checklist

Code Quality

  • Code follows the project's style guidelines (run make format and make fcheck)
  • Self-review of code completed
  • Code is well-commented, especially in complex areas
  • No unnecessary debug logs or commented-out code

Compatibility

  • Changes are backward compatible (or breaking changes are documented)
  • Existing tests pass with changes
  • No new warnings introduced

Testing

  • Tested with FSDP (if applicable)
  • Tested with DeepSpeed (if applicable)
  • Tested with inference engines (vLLM/SGLang) (if applicable)
  • Tested on multiple GPU configurations (if applicable)

Documentation

  • All public APIs are documented
  • User-facing changes are documented
  • Migration guide provided (if breaking changes)

💭 Additional Notes

🔍 Review Checklist for Maintainers

  • Code quality and style verified
  • Tests are adequate and passing
  • Documentation is complete and clear
  • Performance impact is acceptable
  • Breaking changes are properly documented
  • Ready to merge

BEFORE SUBMITTING, PLEASE READ:

- Initialize Chinese documentation structure with index files for main, quick start, and best practices pages.
- Implement a polished, floating language toggle button in the bottom-right corner.
- Add a custom SVG language icon and PyTorch-themed styling (accent border and hover effects).
- Create dynamic JavaScript to handle intelligent switching between English and Chinese versions of the same page.
- Update conf.py to globally include the new localized assets and styles.
- Add Chinese docs for model testing, design philosophy, troubleshooting, and core project architecture.
- Standardize all Chinese documentation suffixes from `_cn` to `_zh` to follow standard locale naming.
@puyuan1996 puyuan1996 changed the title Add language switcher and complete some Chinese documentation for LightRFT docs feature(wzn): add language switcher and complete some Chinese documentation for LightRFT docs Feb 10, 2026
@puyuan1996 puyuan1996 added documentation Improvements or additions to documentation style Code or comments formatting labels Feb 10, 2026
@PaParaZz1 PaParaZz1 changed the title feature(wzn): add language switcher and complete some Chinese documentation for LightRFT docs feature(wzn): add language switcher and complete some Chinese doc for LightRFT docs Feb 26, 2026
@PaParaZz1 PaParaZz1 changed the title feature(wzn): add language switcher and complete some Chinese doc for LightRFT docs feature(wzn): add language switcher and complete some Chinese docs Mar 4, 2026
@puyuan1996 puyuan1996 merged commit 49e62cb into opendilab:main Mar 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation style Code or comments formatting

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants