Skip to content

docs(skills): register model support in docs/README.md only - #1355

Merged
DefTruth merged 1 commit into
mainfrom
dev
Nov 18, 2026
Merged

DefTruth merged 1 commit into
mainfrom
dev

Conversation

@DefTruth

Copy link
Copy Markdown
Member

Closes #1354

Why

The root README.md is now intentionally minimal (62 lines: intro / community integration / acknowledgements / citations) and no longer carries the supported-model table — the single authoritative list is docs/README.md → ## 🚪Supported DiT Models. The bundled skills still told contributors (and agents) to add a row to cache-dit/README.md and claimed the two tables "must stay identical", which invites re-adding a duplicate table to the root README.

This PR makes the skills match the current docs layout.

Changes

File Before After
cache-dit-model-integration/SKILL.md — Phase 7.6 README.md model table + docs/README.md (keep the two in sync) + supported_matrix docs/README.md is the only model list; root README carries none
cache-dit-model-integration/SKILL.md — §8 docs table Root README model list | README.md (## 🚪Supported DiT Models); docs/README.md described as a copy of the root README Single docs/README.md row (diffusers table vs built-in table placement); new Root README row stating it is minimal and must not get a model table
cache-dit-model-integration/references/rfc_pending_models.md — §7.2 "the README understates coverage"; Boogu-Image "no README row — supported but unlisted" Criterion is now docs/README.md; Boogu-Image marked as closed (it is vendored under models/pipelines/boogu_image/, the CLI example imports from the package, and it has a docs row), keeping the few-step-DMD payoff caveat
cache-dit-cache-integration/references/extension-points.md — §6 docs落点 docs/user_guide/CACHE_API.md、README.md docs/user_guide/CACHE_API.md、docs/README.md (+ note that the root README no longer documents algorithms)

Workspace-level workflow docs (.codebuddy/commands/cache_dit_task_refs.md #3/#9, .codebuddy/commands/cache_dit_team.md spawn template + PR compliance checklist, .codebuddy/cache-dit-team/TEAM_CHARTER.md §9/§10.2/§10.3/§11) were updated in tandem but live outside this repository, so they are not part of the diff. They now say "two places to sync: docs/README.md + docs/supported_matrix/NVIDIA_GPU.md".

Verification

  • pre-commit run --files <3 changed files> — all hooks pass (only mixed-line-ending / end-of-file-fixer apply to markdown).
  • Statement cross-checked against the repo: wc -l README.md = 62 with no model table; docs/README.md:113 starts ## 🚪Supported DiT Models with the diffusers table (:121) followed by the built-in table (:218); src/cache_dit/models/pipelines/boogu_image/ exists and cli/examples.py imports BooguImagePipeline from it.
  • Docs-only change: no code, no benchmarks, no image/video assets.

Root README.md is now intentionally minimal (intro / community integration /
citations) and no longer carries the supported-model table, so the skill and
its references must stop pointing model registration at it.

- cache-dit-model-integration: Phase 7.6 and the documentation table now name
  docs/README.md as the single authoritative model list; add an explicit
  "do not add a model table to the root README" row.
- rfc_pending_models 7.2: drop the stale Boogu-Image row (it is vendored under
  models/pipelines/boogu_image and listed in docs/README.md); keep the payoff
  caveat.
- cache-dit-cache-integration extension points: new cache algorithms go to
  docs/user_guide/CACHE_API.md + docs/README.md, not the root README.
@DefTruth
DefTruth merged commit 2e84bba into main Nov 18, 2026
2 checks 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.

[Docs] Point model-support registration at docs/README.md after root README minimization

1 participant