Repository navigation
docs(readme): list password reset among the point-system capabilities - #425
Merged
Merged
Conversation
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.
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
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
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:README.md:16README.en.md:16docs/user-stories.md:37Four 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 in6d87213(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-passwordandPOST /api/auth/reset-password(src/routes/mod.rs:653and 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
readme_gate's four families (src/readme_gate.rs:59-66) are untouched and the two lists stay word-for-word equivalent.git show v0.7.33:README.mdline 16 carries the short list unchanged, andgit merge-base --is-ancestor c6cb9ae v0.7.33says 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_modelsdeletes every model row absent fromconfig.tomlon 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 (includesreadme_gate,deploy_gate)cargo fmt --check— cleancargo clippy --all-targets— no warningsreadme_gate's parity check anddeploy_gate's build-context rules)Checklist
docs/)