Skip to content

docs(ui): complete four stale capability lists in ui/README.md - #325

Merged
argszero merged 1 commit into
mainfrom
docs/ui-readme-capability-lists
Sep 29, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/ui-readme-capability-lists

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

ui/README.md has four subsections that enumerate a capability (a coverage list, a call-site count, a table roster, a renderer's content list). Each was written when it was true and was never extended when a later feature landed, so it now states a list or count the code no longer matches. This PR corrects the four values to what the code implements. Documentation only — no code, no gate.

Related Issue

None (self-found during a documentation audit; no tracking issue exists).

Changes

  • Four value corrections in ui/README.md, one per stale subsection:
    • inline-confirm coverage list (已覆盖) omitted model deletion — ui/js/app.js calls confirmInline(..., deleteModel(…)) alongside key/sharing/department deletion. Added 模型删除.
    • timeCell call-site count said "two call sites" (transactions / API Key) — there are three: the raise-request list's created_at (ui/js/app.js, admin.raise row) is the third. Corrected to 交易/API Key/加额申请三个调用点.
    • data-label table roster omitted the admin model table (#model-body), while the same file's keyboard-navigation section already lists model-body — a self-contradiction. Added 模型.
    • mkDetailHtml content list omitted peak-hour pricing — the renderer appends it conditionally (if (m.peak), ui/js/app.js:863), exactly like the sibling conditional m.multi which is listed. Added 高峰时段价(仅 m.peak 显示…).
  • No configuration/data-structure changes, so no example-file sync is required.

Tests

Checklist

  • Branch name follows the convention (docs/<description>)
  • Commit message uses Conventional Commits (docs(ui): …)
  • Single responsibility, minimal change (1 file, +4/−4)

Four subsections enumerate a capability and were never extended when a
later feature landed, so each states a count/list the code no longer
matches:

- inline-confirm coverage list omitted model deletion (app.js calls
  confirmInline(deleteModel...));
- timeCell was said to have two call sites; there are three (the raise
  request list's created_at is the third);
- the data-label table list omitted the admin model table
  (model-body), contradicting the same file's keyboard-nav section;
- the mkDetailHtml content list omitted peak-hour pricing
  (if (m.peak)), while the sibling conditional multi was listed.

Documentation only; no code or gate changes.
@argszero

Copy link
Copy Markdown
Owner Author

Self-review (committer, allow_self_merge: true).

Verified against the tree this branch is based on (dee6a24):

  1. confirmInline call sites in ui/js/app.js: sharing (4167), API key (4284), department (4354), model (4377) — four; the old list named three.
  2. timeCell calls: raise-request created_at (1445), transactions time column (1485), API Key last-used (2408) — three; the old text said two. (:3221 is the definition.)
  3. The data-label roster now matches the same file's keyboard-nav section, which already listed model-body (admin model table, ui/index.html:701) — the file no longer contradicts itself.
  4. mkDetailHtml appends peak-hour pricing conditionally (if (m.peak), ui/js/app.js:863), the same shape as the already-listed m.multi.

ui/README.md is include_str! corpus, so the full suite was re-run: cargo test 426/0, cargo fmt --check rc 0, cargo clippy --all-targets -- -D warnings rc 0.

Documentation-only change; no gate added, consistent with the repo's doc-comment-claims convention.

@argszero
argszero merged commit 9df6d00 into main Sep 29, 2026
2 checks passed
@argszero
argszero deleted the docs/ui-readme-capability-lists branch September 29, 2026 10:05
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