Skip to content

docs(readme): list password reset among the point-system capabilities - #425

Merged
argszero merged 1 commit into
mainfrom
docs/readme-name-the-reset-capability
Oct 20, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/readme-name-the-reset-capability

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

The README feature list enumerates the point system's capabilities and stops one item short of the canonical list in docs/user-stories.md:37:

Carrier The list
README.md:16 每日赠送、共享分成(90/10)、管理员加额、自助注册 + 邮箱验证
README.en.md:16 daily gift, 90/10 sharing split, admin top-up, self-registration with email verification
docs/user-stories.md:37 the same four, plus 找回密码

Four items identical and in the same order, only the tail differs — that is a short enumeration, not a selective one. The README copy was written in 80c53bf (2026-08-21) and the story copy in 6d87213 (2026-08-22), so the item added to the second copy never propagated back to the first.

Why it matters beyond bookkeeping. The README sells registration as gated on email verification (README.md:58), and then says nothing at all about what happens when a user forgets the password — grepping either README for 找回密码 / forgot / reset returns nothing. The product does have the self-service path: POST /api/auth/forgot-password and POST /api/auth/reset-password (src/routes/mod.rs:653 and its sibling), reached from the 找回密码 link under the login form (ui/index.html:79). A deployer reading only the README plans for manual resets over a capability that exists.

Related Issue

None — no issue was open for this.

Changes

-- **点数体系** — 每日赠送、共享分成(90/10)、管理员加额、自助注册 + 邮箱验证
+- **点数体系** — 每日赠送、共享分成(90/10)、管理员加额、自助注册 + 邮箱验证、找回密码

-- **Point system** — daily gift, 90/10 sharing split, admin top-up, self-registration with email verification
+- **Point system** — daily gift, 90/10 sharing split, admin top-up, self-registration with email verification, password reset
  • 2 files, +1 / −1 each. No number literal, inline-code span, link target or bare URL changes, so readme_gate's four families (src/readme_gate.rs:59-66) are untouched and the two lists stay word-for-word equivalent.
  • Measured on what the project ships: git show v0.7.33:README.md line 16 carries the short list unchanged, and git merge-base --is-ancestor c6cb9ae v0.7.33 says the current head is not in that release — the omission is live in the released artifact.

Deliberately not included. The sibling "Enterprise controls" bullet also lacks user-stories' 模型管理 CRUD, but adding it would overclaim: db.rs::seed_models deletes every model row absent from config.toml on each boot, so admin-side model edits do not survive a restart. Naming the capability without that caveat would mislead more than the omission does.

Tests

  • cargo test — 579 passed, 0 failed (includes readme_gate, deploy_gate)
  • cargo fmt --check — clean
  • cargo clippy --all-targets — no warnings
  • New tests: not applicable (documentation-only; both READMEs are already covered by readme_gate's parity check and deploy_gate's build-context rules)

Checklist

  • Branch name follows the convention (docs/)
  • Commit message uses Conventional Commits
  • Single purpose, minimal diff

The README feature list enumerates the point system's capabilities, and it
stops one item short of the canonical list in `docs/user-stories.md:37`:

  README.md / README.en.md : daily gift / 90-10 split / admin top-up /
                             self-registration with email verification
  docs/user-stories.md:37  : the same four, plus password reset

Two copies of one list, four items identical and in the same order, only
the tail differs — the enumeration is short, not selective. The README copy
was written in 80c53bf (2026-08-21) and the story copy in 6d87213
(2026-08-22), so the second one never propagated back.

It also answers a decision a deployer is actually making: registration is
advertised as gated on email verification, and the README then says nothing
about what happens when a user forgets the password. The product does have
the self-service path — `POST /api/auth/forgot-password` and
`POST /api/auth/reset-password` (src/routes/mod.rs), reached from the
"找回密码" link under the login form — so the operator plans for manual
resets over a capability that exists.

Add the item to both languages. No numbers, inline code, links or bare URLs
change, so readme_gate's four families are untouched; the two lists stay
word-for-word equivalent.

Deliberately not included: the sibling "Enterprise controls" bullet also
lacks user-stories' "模型管理 CRUD". `db.rs::seed_models` deletes model rows
absent from config on every boot, so admin-side model edits do not survive a
restart — naming that capability without the caveat would overclaim more
than the omission does.
@argszero
argszero merged commit 0d089a8 into main Oct 20, 2026
2 checks passed
@argszero
argszero deleted the docs/readme-name-the-reset-capability branch October 20, 2026 21:56
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