Skip to content

Docs/link lora training tutorials#607

Merged
ChuxiJ merged 3 commits intomainfrom
docs/link-lora-training-tutorials
Feb 16, 2026
Merged

Docs/link lora training tutorials#607
ChuxiJ merged 3 commits intomainfrom
docs/link-lora-training-tutorials

Conversation

@ChuxiJ
Copy link
Contributor

@ChuxiJ ChuxiJ commented Feb 16, 2026

This pull request enhances LoRA training documentation and improves Markdown rendering in the Gradio UI. The main changes add step-by-step LoRA Training Tutorials in multiple languages, update documentation links throughout the project, and improve the Markdown-to-HTML converter to support links in all contexts. Tests are also added to ensure correct link rendering.

Documentation and Tutorial Improvements:

  • Added a dedicated "LoRA Training" column and links for all supported languages (English, 中文, 日本語, 한국어) in the multi-language documentation table in README.md.
  • Expanded the "Train" section in README.md to include a clear, language-specific table of LoRA Training Tutorials and a reference to advanced CLI training with Side-Step.
  • Updated the LoRA training and dataset builder documentation in English, Chinese, and Japanese Gradio UI translation files to include direct links to the new LoRA Training Tutorials and Side-Step documentation. [1] [2] [3]
  • Added a prominent reference to the LoRA Training Tutorial in the Gradio Guide for LoRA Training.

Markdown Rendering Enhancements:

  • Improved the _md_to_html function in acestep/ui/gradio/help_content.py to support Markdown links ([text](url)) in headings, blockquotes, list items, and paragraphs, rendering them as styled <a> tags that open in a new tab. [1] [2] [3]
  • Added tests for link rendering in paragraphs, list items, blockquotes, and headings in help_content_test.py.

Summary by CodeRabbit

Release Notes

  • New Features

    • Links in help content now open in a new tab when clicked.
    • Added documentation subsections to training tutorial sections.
  • Documentation

    • Enhanced English localization with refined training descriptions.
    • Added Japanese and Chinese translations for training documentation and new generation parameters.
  • Tests

    • Added test coverage for link rendering across different content contexts.

chuxij added 2 commits February 16, 2026 10:59
- Add LoRA Training Tutorial links to README Train section (4 languages)
- Add LoRA Training column to README multi-language docs table
- Link LoRA Training Tutorial from Tutorial.md (en/zh/ja)
- Link LoRA Training Tutorial from GRADIO_GUIDE.md (en/zh/ja/ko)
- Add Side-Step advanced training section to all 4 LoRA Training Tutorials
- Add Side-Step documentation entry in README Train section
- Add '📖 Documentation' section with links to LoRA Training Tutorial
  and Side-Step Getting Started in training_dataset and training_train
  help content for en/zh/ja
- Add Markdown link ([text](url)) → HTML <a> conversion to _md_to_html
  for paragraphs, list items, blockquotes, and headings
- Add unit tests for link rendering in all supported contexts
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request enhances Markdown-to-HTML conversion in the help content module to automatically transform Markdown links into HTML anchor tags with external link styling. It adds corresponding test coverage for the new link rendering behavior across multiple contexts and updates localization strings to reference documentation links.

Changes

Cohort / File(s) Summary
Markdown Link Processing
acestep/ui/gradio/help_content.py
Implements regex-based transformation of Markdown links [text](url) into HTML anchors with target="_blank" attribute across headings, blockquotes, list items, and paragraphs. Modifies internal conversion pipeline without changing public API.
Test Coverage
acestep/ui/gradio/help_content_test.py
Adds four new test methods (test_link_in_paragraph, test_link_in_list_item, test_link_in_blockquote, test_link_in_heading) to verify link rendering produces proper anchor elements with href and text content.
Localization Updates
acestep/ui/gradio/i18n/en.json, ja.json, zh.json
Updates training section UI strings to include "📖 Documentation" subsections with external documentation links. Adds normalization and latent handling parameter labels in Japanese and extends Chinese training workflow content.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Poem

🐰 Links now hop through markdown bright,
Opening doors in tabs, what a sight!
Documentation guides, in every tongue,
External anchors dance—the code is sung!
New tests ensure each link takes flight,
Web navigation's never been so right! 🌐

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/link-lora-training-tutorials

Comment @coderabbitai help to get the list of available commands and usage tips.

@ChuxiJ ChuxiJ merged commit 8b74648 into main Feb 16, 2026
1 check passed
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