Skip to content

docs(user-stories): name every view the bilingual UI has - #428

Merged
argszero merged 1 commit into
mainfrom
docs/user-stories-name-the-views-the-ui-has
Oct 22, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/user-stories-name-the-views-the-ui-has

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

docs/user-stories.md section 3 is headed "capability list (mirrors the README features)", and its last bullet claims a bilingual front end across "all pages" while naming six: market / wallet / transactions / sharing / admin / settings. The UI has eight views, and the bullet omits the dashboard and the operator view.

Three independent readers agree on the roster:

reader what it shows
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 page titles in both language packages (zh :99-106, en :942-949)

The omission contradicts the document itself twice over, so it is not a different way of grouping the views:

  • Line 38 of the same list names the operator view ("enterprise controls: departments, member points, usage reports, operator view, model management CRUD"), and the roles table at :13 describes it as a view of its own.
  • The README this section says it mirrors already got this fixed: README.md:20 and README.en.md:20 listed all eight in docs(readme): name the web views the UI actually has #426.

The dashboard matters in particular because it is the view a user lands on after login — app.js:575 falls back to dashboard for any hash it does not recognise — so a reader asking "is the dashboard bilingual?" got "no" from this list.

Related Issue

None. There is no open issue in this repository; the defect was found while reading the docs against the code.

Changes

  • docs/user-stories.md:40 — name all eight views, in sidebar (NAV) order, in the wording README.md:20 already uses.
  • No configuration or data-structure change, so no sample file needed updating.

The line is now name-for-name identical to README.md:20's roster, which is what the section claims to mirror.

Tests

  • cargo test — 579 passed, 0 failed
  • cargo fmt --check — clean
  • cargo clippy --all-targets — no warnings
  • New unit tests — not applicable: this is prose, and no gate reads docs/user-stories.md (grep -rn user-stories src/ finds one comment in gift.rs). Correcting the data rather than pinning a wording is this axis' standing rule.

Checklist

  • Branch name follows the convention (docs/)
  • Commit message uses Conventional Commits
  • Single responsibility, smallest possible diff (1 file, +1/−1)

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.
@argszero
argszero merged commit ec9079d into main Oct 22, 2026
2 checks passed
@argszero
argszero deleted the docs/user-stories-name-the-views-the-ui-has branch October 22, 2026 02:09
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