Skip to content

Refresh CLI docs and strip private notes from pyproject.toml - #188

Merged
KraHsu merged 1 commit into
mainfrom
hotfix/cleanup_docs
May 29, 2026
Merged

KraHsu merged 1 commit into
mainfrom
hotfix/cleanup_docs

Conversation

@KraHsu

@KraHsu KraHsu commented May 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • Bring docs/cli/ in sync with the current command surface: asset subcommand group, post-training runtime commands (eval, export, benchmark), multi-seed train (--seeds / --parallel), in-training eval (--eval_every + friends), --headless, --dt, --no-entry-points; profiling page gains prof open --port/--host and the GENELAB_PROFILE* env-var column.
  • Unify H1 templates: command pages use \`Category: cmd1 and cmd2\``` / `分类:cmd1 与 cmd2```; concept pages use a single noun. Updated mkdocs nav labels to match.
  • Strip ADR / ROADMAP / R-phase markers from pyproject.toml comments (local-private references; contract logic and contract names unchanged).
  • Bumps the genelab entry in uv.lock to 0.3.0 to track the package version already in pyproject.toml.

Test plan

  • `uv run ruff check` — all checks passed
  • `uv run ruff format --check` — 314 files already formatted
  • `uv run lint-imports` — 8 contracts kept, 0 broken
  • `uv run pyright` — 0 errors / 0 warnings
  • `uv run pytest` — 655 passed
  • `uv run mkdocs build --strict` — clean (en + zh)
  • Local `mkdocs serve` walkthrough of the five CLI pages

🤖 Generated with Claude Code

Bring docs/cli/ in line with current command surface (asset / eval / export /
benchmark / multi-seed train / in-training eval / --headless / --dt) and
unify H1 templates across the five pages and both languages. Remove ADR /
ROADMAP / R-phase markers from pyproject.toml comments (they reference local
private notes and shouldn't ship to PyPI consumers); contract logic itself is
unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@KraHsu
KraHsu merged commit 71ea784 into main May 29, 2026
4 checks passed
@KraHsu
KraHsu deleted the hotfix/cleanup_docs branch May 29, 2026 09:30
KraHsu added a commit that referenced this pull request Jun 5, 2026
Refresh CLI docs and strip private notes from pyproject.toml
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