Skip to content

Docs: refresh README quickstart, architecture and release guidance - #533

Open
Dong1017 wants to merge 1 commit into
mainfrom
codex/refresh-readme-531
Open

Dong1017 wants to merge 1 commit into
mainfrom
codex/refresh-readme-531

Conversation

@Dong1017

Copy link
Copy Markdown
Collaborator

Closes #531

What changed

  • Architecture and compatibility (F1, F3, F4, S1, D1). Link the offline controller to the Apps workflow, Benchmark acceptance rules and Harness candidate selection. Refresh both diagrams shared by the README and architecture guide, correct the host inspection importer and repository-pack path, and point Python callers to the import migration list. Rendered architecture section.
  • News and results (F2, S2). Add the v0.2.6 milestone and explain when daily previews ship. Recheck all 11 linked vLLM-Omni PRs on 2026-11-20. The MiniMax-H3-Image change merged and the three drafts retain their labels. The table now includes a command for checking future status changes. vLLM-Omni PR #10184.
  • Getting started (M1–M4). Run the CPU target check and list packaged tasks before searching. Document the five backend choices, the opt-in CANNbot checkout and interpreter, the separate MindIE reader and how to revoke either project grant. Account for the knowledge reorganization that landed after the issue audit, including the availability of skills enter after v0.2.6 and the current knowledge entry points.

Verification

  • Built and installed the wheel from this head on Windows with Python 3.12. Verified its embedded README matches the committed file. Also installed the published v0.2.6 wheel in a separate environment after checking its SHA-256.
  • On both installs, ran CLI help, CPU doctor from a vLLM-Omni checkout, benchmarks list, the README search, a material read from its first hit and both context exports. Each export returned five records. Confirmed the fresh checkout reports CANNbot as disabled, the replacement host imports load and the retired imports fail. Confirmed skills enter task-performance on the source build and the older command set on v0.2.6.
  • Checked the README's 53 unique repository targets, including ten cross-document anchors, and all 37 external HTTP targets. Checked local targets in the other three edited Markdown pages. Rendered both SVGs in Chromium, checked label bounds and verified all 17 paths in the directory graphic against Git.
  • Ruff and git diff --check passed. Across the targeted tests and the outside-Git rerun, 241 tests passed with 54 passing subtests. Three host-specific tests skipped on Windows (two POSIX process-group cases and one Apple Silicon probe).

The issue owner is submitting this revision for review and closure on merge. Verification covered documentation, CLI behavior and upstream PR metadata. Performance and quality figures retain their original campaign evidence. GUI plugin installation was outside this run.

Align the shared diagrams, paths and import guidance with the current package tree. Document the checkout-scoped knowledge grants and distinguish the released CLI from task entry on main.

Agent-assisted-by: Codex (author)
Signed-off-by: Dong1017 <55723162+Dong1017@users.noreply.github.com>
@Dong1017 Dong1017 added the kind:docs Documentation and template delivery label Nov 20, 2026

@zengchuang-hw zengchuang-hw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

PASS

初次独立检视 1b826b5f → 23be5b72,逐项看了六处文档/图示变更与 #531 的修订:三个上游 Draft 标注仍保留,#10184 更新为已合入;Find 只说明当前注册的 Cannbot,MindIE 的 CLI/reader 单列。旧 import 路径的兼容边界、图示资源、当前架构链接、CLI 参数和授权路径也与源码对齐。无批准前必修项。

非阻塞:可把 v0.2.6 标为 preview,和发布页措辞一致。已静态核对源码、文档链接及 11 个上游 PR 状态;未执行 CLI、渲染图示或查询 CI。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:docs Documentation and template delivery

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: refresh README items that no longer match the repository (2026-11-20 audit)

2 participants