Skip to content

[bugfix] Write generated documentation as UTF-8 - #1797

Merged
SolitaryThinker merged 1 commit into
hao-ai-lab:mainfrom
shahradzomorrodi:docs/utf8-example-generation
Sep 1, 2026
Merged

[bugfix] Write generated documentation as UTF-8#1797
SolitaryThinker merged 1 commit into
hao-ai-lab:mainfrom
shahradzomorrodi:docs/utf8-example-generation

Conversation

@shahradzomorrodi

@shahradzomorrodi shahradzomorrodi commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Purpose

Make generated example documentation build reliably on Windows. Before this change, python docs/generate_examples.py could fail with UnicodeEncodeError when Python selected the system cp1252 encoding and an example contained Unicode.

Changes

  • Write all generated Markdown files with explicit UTF-8 encoding.
  • Keep source reads and generated writes on the same encoding without changing content on UTF-8-default systems.

Test Plan

python docs/generate_examples.py
python scripts/check_docs_links.py
python -m py_compile docs/generate_examples.py
pre-commit run --files docs/generate_examples.py
python -m mkdocs build

Test Results

Test output
Generating example documentation...
Example documentation generated successfully!
Docs link check passed.
MkDocs build passed.
yapf, ruff, codespell, mypy, and repository filename checks passed.

Checklist

  • I ran pre-commit run --all-files and fixed all issues
  • I added or updated tests for my changes
  • I updated documentation if needed
  • I considered GPU memory impact of my changes

For model/pipeline changes, also check:

  • I verified SSIM regression tests pass
  • I updated the support matrix if adding a new model

@mergify mergify Bot added type: bugfix Bug fix scope: docs Documentation labels Aug 31, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to FastVideo! Thanks for your first pull request.

How our CI works:

PRs run a three-tier CI system:

  1. Pre-commit — formatting (yapf), linting (ruff), type checking (mypy). Runs immediately on every PR.
  2. Fastcheck — six core GPU lanes run automatically via Buildkite (~10-15 min).
  3. Merge gate — a reviewer adds ready; changed paths select only the relevant integration, training, golden, or SSIM coverage.

Before your PR is reviewed:

  • pre-commit run --all-files passes locally
  • You've added or updated tests for your changes
  • The PR description explains what and why

If pre-commit fails, a bot comment will explain how to fix it. Fastcheck and merge-gate results appear in the Checks section below.

Useful links:

@mergify

mergify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🔴 1 of 1 protections blocking · waiting on 👀 reviews and 🤖 CI

Protection Waiting on
🔴 PR merge requirements 👀 reviews and 🤖 CI

🔴 PR merge requirements

Waiting for

  • #approved-reviews-by>=1
  • check-success=full-suite-passed
This rule is failing.
  • #approved-reviews-by>=1
  • check-success=full-suite-passed
  • check-success=fastcheck-passed
  • check-success~=pre-commit
  • title~=(?i)^\[(feat|feature|bugfix|fix|refactor|perf|ci|doc|docs|misc|chore|kernel|new.?model|skill|skills|infra)\]

@SolitaryThinker
SolitaryThinker merged commit 1ae3956 into hao-ai-lab:main Sep 1, 2026
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope: docs Documentation type: bugfix Bug fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants