Repository navigation
Add bilingual MkDocs documentation site with GitHub Pages deploy - #4
Merged
Merged
Conversation
The single README has outgrown its role as the project surface area expands (CLI subcommands, registries, config override grammar, project new scaffolding). Replace it with a proper docs site so each topic has a stable, linkable home and Chinese readers get parity with English. Stack: MkDocs Material + mkdocs-static-i18n + mkdocstrings + the include-markdown plugin. English is the default at /, Chinese lives at /zh/. The API Reference is single-source, auto-generated from package docstrings under src/genelab. The contributing page inlines the root CONTRIBUTING.md so there is one source of truth. Build and deploy run on GitHub Actions (.github/workflows/docs.yml): uv sync --extra docs --extra torch-cpu, then mkdocs build --strict, then deploy-pages. Verified locally with zero strict-mode warnings. EOF \)" git commit -m "$(cat << 'EOF' Add bilingual MkDocs documentation site with GitHub Pages deploy The single README has outgrown its role as the project surface area expands (CLI subcommands, registries, config override grammar, project new scaffolding). Replace it with a proper docs site so each topic has a stable, linkable home and Chinese readers get parity with English. Stack: MkDocs Material + mkdocs-static-i18n + mkdocstrings + the include-markdown plugin. English is the default at /, Chinese lives at /zh/. The API Reference is single-source, auto-generated from package docstrings under src/genelab. The contributing page inlines the root CONTRIBUTING.md so there is one source of truth. Build and deploy run on GitHub Actions (.github/workflows/docs.yml): uv sync --extra docs --extra torch-cpu, then mkdocs build --strict, then deploy-pages. Verified locally with zero strict-mode warnings.
KraHsu
added a commit
that referenced
this pull request
May 15, 2026
Add bilingual MkDocs documentation site with GitHub Pages deploy
This was referenced May 16, 2026
KraHsu
added a commit
that referenced
this pull request
Jun 5, 2026
Add bilingual MkDocs documentation site with GitHub Pages deploy
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The single README has outgrown its role as the project surface area expands (CLI subcommands, registries, config override grammar, project new scaffolding). Replace it with a proper docs site so each topic has a stable, linkable home and Chinese readers get parity with English.
Stack: MkDocs Material + mkdocs-static-i18n + mkdocstrings + the include-markdown plugin. English is the default at /, Chinese lives at /zh/. The API Reference is single-source, auto-generated from package docstrings under src/genelab. The contributing page inlines the root CONTRIBUTING.md so there is one source of truth.
Build and deploy run on GitHub Actions (.github/workflows/docs.yml): uv sync --extra docs --extra torch-cpu, then mkdocs build --strict, then deploy-pages. Verified locally with zero strict-mode warnings. EOF )"
git commit -m "$(cat << 'EOF'
Add bilingual MkDocs documentation site with GitHub Pages deploy
The single README has outgrown its role as the project surface area expands (CLI subcommands, registries, config override grammar, project new scaffolding). Replace it with a proper docs site so each topic has a stable, linkable home and Chinese readers get parity with English.
Stack: MkDocs Material + mkdocs-static-i18n + mkdocstrings + the include-markdown plugin. English is the default at /, Chinese lives at /zh/. The API Reference is single-source, auto-generated from package docstrings under src/genelab. The contributing page inlines the root CONTRIBUTING.md so there is one source of truth.
Build and deploy run on GitHub Actions (.github/workflows/docs.yml): uv sync --extra docs --extra torch-cpu, then mkdocs build --strict, then deploy-pages. Verified locally with zero strict-mode warnings.