Skip to content

Add bilingual translation and comprehensive user documentation#6

Open
patofoto wants to merge 8 commits intoFly3DTeam:mainfrom
patofoto:translation-with-user-guide
Open

Add bilingual translation and comprehensive user documentation#6
patofoto wants to merge 8 commits intoFly3DTeam:mainfrom
patofoto:translation-with-user-guide

Conversation

@patofoto
Copy link
Copy Markdown

@patofoto patofoto commented Dec 5, 2025

Summary

This PR adds English translations to the codebase and provides comprehensive user documentation to make the firmware more accessible to international users.

Changes

🌐 Translation Work

  • Bilingual comments: All Chinese comments translated to English while preserving original Chinese text
  • Files translated:
    • lib/buffer/buffer.h - Fully translated
    • lib/buffer/buffer.cpp - Header and global variables translated
    • Comments are bilingual (English + Chinese) for universal understanding

📚 Documentation

  • Comprehensive README.md: Complete user guide with:
    • Installation and setup instructions
    • Runtime configuration guide (serial commands)
    • Compile-time configuration guide (advanced users)
    • Command reference table
    • Common use cases with examples
    • Troubleshooting section
    • Uses VS Code Find instructions (no line numbers) for maintainability

📝 Developer Notes

  • DEVELOPER_NOTES.md: Documents potential issues found during translation:
    • Version number mismatch (file headers show V1.0.0 but code is v1.1.x)
    • DIR_PIN redefinition compiler warning
    • Missing GitHub Releases suggestion
    • Translation status

Benefits

  1. Accessibility: Non-Chinese speakers can now understand and modify the code
  2. User Experience: Clear documentation helps users configure and troubleshoot
  3. Maintainability: Documentation uses search-based instructions instead of line numbers
  4. Developer Feedback: Notes highlight areas for improvement

Testing

  • ✅ Code compiles successfully
  • ✅ All functionality preserved (no code logic changes)
  • ✅ Documentation tested for clarity and accuracy

Notes

  • No functional code changes - only comments and documentation
  • All original Chinese text preserved alongside English
  • Ready for review and merge

- Translated buffer.h: pins, structures, function declarations
- Translated buffer.cpp: header, global variables, watchdog init
- Fixed DIR_PIN naming conflict (motor vs MDM signal)
- Kept Chinese alongside English for reference
- Compilation successful with no warnings
- Added warning comments about DIR_PIN being redefined
- Reverted code changes to keep developer's original logic
- Only translation comments added, no code modifications
- Compilation successful with expected warnings
- Complete installation and setup instructions
- Runtime configuration guide (serial commands)
- Compile-time configuration guide (advanced)
- Command reference table
- Common use cases with examples
- Troubleshooting section
- Replaced line numbers with VS Code Find instructions for maintainability
- Added dfu-util installation to prerequisites
- Large, scannable headers for easy navigation
- Document missing GitHub Releases for existing tags
- Provide recommendations for creating releases with notes
- Include example release notes structure
- Update branch name in footer
- Translated all remaining 59 Chinese-only comments in function implementations
- All comments now bilingual (English + Chinese)
- No functional code changes, only comment translations
- buffer.cpp now fully translated
Avatarsia pushed a commit to Avatarsia/BufferPLUS-klipper that referenced this pull request Apr 22, 2026
12 Verbesserungen aus der parallelen LLL_Plus-Variante integriert.
Unser Refactor (Helpers, Parametrisierung, Raw-State) bleibt.

Kategorie A - Sensor- und Event-Filterung:
 ss1gohan13#1 Sensor disable waehrend Erstbefuellung, reaktivieren in
    _initial_follow_end, STOP_BUFFER_FILL, BUFFER_AUTO_ON
 ss1gohan13#2 runout_gcode ignoriert Events wenn manual_operation==1
 Fly3DTeam#3 HALL2/HALL3 Guards erweitert um manual_operation-Check
 Fly3DTeam#4 HALL1 selektiv: nur _MANUAL_FEED stoppen, LOAD/UNLOAD
    weiterlaufen lassen. action_respond_info() statt M118 mit
    Emoji. Guard zusaetzlich.

Kategorie B - Toggle-Features:
 Fly3DTeam#6 variable_feed_burst_enabled (default 0): Triple-Feed-Burst
    nur aktiv wenn =1. Default = sicher (Dauerlauf-Neustart).
 Fly3DTeam#8 variable_auto_load_after_follow (default 0): nach Follow-Phase
    automatisch LOAD_FILAMENT wenn Hotend warm, nur wenn =1.

Kategorie C - UNLOAD-Praezision:
 Fly3DTeam#9 Phase 3a Distanz = load_fast_distance + Follow-Strecke
    (initial_follow_speed * initial_follow_duration).
 Fly3DTeam#10 sync_locked=0 und sync_state=0 explizit am UNLOAD-Ende.

Kategorie D - Diagnose:
 Fly3DTeam#11 _STATE_DUMP zeigt sync_locked und sync_state.
 Fly3DTeam#12 _boot_autostart ueberspringt BUFFER_AUTO_ON wenn
     initial_lockout==1 (Stromausfall-Edge-Case).
 Fly3DTeam#13 ENABLE/DISABLE_RUNOUT_SENSOR description nennt
     runout_pause=1-Abhaengigkeit explizit.

Punkt Fly3DTeam#5 (M118 -> action_respond_info flaechig) bewusst uebersprungen -
nur HALL1 bekommt das, Rest bleibt M118.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant