Repository navigation
docs(readme): name the web views the UI actually has - #426
Merged
Merged
Conversation
The feature list said "full Web 界面 (市场 / 钱包 / 交易 / 共享 / 管理)". The sidebar has eight entries, and three independent readers agree: ui/js/app.js's NAV registry (5 main + 3 role items), the eight <section class="view" id="view-*"> blocks in ui/index.html, and ui/README.md's hash-view roster. Settings and the dashboard -- the two a newcomer needs first, since the former holds the generated API key and the endpoint shown to clients -- were missing, while the same README tells the reader "接入地址在设置页展示" one section later. The roster is now copied in the sidebar's own order and wording (NAV_ORDER; nav.* i18n labels), in both language versions. No count is written: a number here is a second copy of a fact the code owns, and it goes stale the moment a view is added. Tests: cargo test 579 passed / 0 failed (readme_gate and deploy_gate included); cargo fmt --check and cargo clippy --all-targets clean.
8 of 9 tasks
argszero
added a commit
that referenced
this pull request
Oct 22, 2026
Section 3's last bullet claims a bilingual front end across "all pages"
and then names six: market, wallet, transactions, sharing, admin,
settings. The UI has eight.
ui/js/app.js:537-551 NAV dashboard / marketplace / sharing /
wallet / transactions / admin / ops /
settings
ui/js/app.js:555-562 VIEW_TITLE the same eight keys; VALID_VIEWS is
its key set (:565)
ui/js/i18n.js view.* all eight titles in both language
packages (zh :99-106, en :942-949)
The omission contradicts the document itself twice over. Line 38 of the
same list names the operator view ("enterprise controls: ... operator
view"), and the roles table at :13 describes it as a view of its own. It
also contradicts the README this section says it mirrors: README.md:20
and README.en.md:20 have listed all eight since #426.
The fix is one line: name all eight, in sidebar order, in the wording the
README already uses. No gate reads docs/user-stories.md -- grep -rn
user-stories src/ finds one comment in gift.rs -- so this corrects the
data without adding a guard, which is the axis' standing rule.
Co-authored-by: argszero <argszero@argszerodeMac-mini.local>
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.
Summary
README.md:20/README.en.md:20advertised the web UI as "完整 Web 界面（市场 / 钱包 / 交易 / 共享 / 管理）". The sidebar has eight entries, and the roster named five of them — the two a new reader needs first were among the missing: settings (where the generated API key and the public endpoint live) and the dashboard (the view a signed-in user lands on).Three independent readers agree on the set:
ui/js/app.js:537-553NAVregistry — five main items + three role items — flattened intoNAV_ORDER;VIEW_TITLE:555is the same eight keysui/index.html<section class="view" id="view-*">blocks: dashboard / marketplace / sharing / wallet / transactions / settings / admin / opsui/README.md:187It also contradicted the README itself: line 65 says "接入地址在设置页展示" (the access URL is shown on the settings page) one section after the feature list said there is no settings page.
The roster is now copied in the sidebar's own order and wording —
NAV_ORDERand thenav.*i18n labels — in both language versions.full dashboard (...)becamefull interface (...), because "dashboard" is one of the eight views, not the name of the whole UI.Changes
README.md:20andREADME.en.md:20now list all eight views, in the sidebar's order, using its labelsDeliberately no count. Writing "8 views" would make the sentence a second copy of a fact
VIEW_TITLEowns, and it would go stale the moment a view is added — this axis has already ruled that way once (ui/README.md's 「非 7 视图」 was removed in #370 for exactly this). The names are the claim; the code owns the number.Tests
cargo test— 579 passed / 0 failed (includesreadme_gate, which compares inline code spans, link targets, bare URLs and number literals across the two READMEs — this change adds none of the four, and both languages were edited together; anddeploy_gate, which reads the READMEs only for the fenced code blocks' master key and version strings)cargo fmt --check— cleancargo clippy --all-targets— cleanVIEW_TITLE)Checklist
docs/)docs(readme): ...)