docs: three README.md claims are contradicted by the shipped code #213

New Issue

2026-08-11T14:34:06+02:00

clawbot commented

2026-08-11 14:34:06 +02:00

Found while verifying documentation against source in #163 and #164. All three are in README.md and were deliberately left alone by those units as out of their scope.

1. Phishing blocklist attribution points at the wrong upstream. The license table cites AugurProject/eth-phishing-detect, but the runtime fetch URL at src/shared/phishingDomains.js:17 points at a competitor's org fork of that repo. One of the two is wrong. This also intersects the no-competitor-names policy — resolving it may mean changing the URL rather than the attribution, so establish which upstream is intended before editing either.

2. The "no token auto-discovery" guarantee is not what the code does. src/shared/balances.js displays any ERC-20 with a nonzero balance that is on the bundled list, tracked, or has at least 1,000 holders. Tokens therefore appear without the user adding them. The filtering is plainly deliberate — the code comments say so — so the likely fix is to describe the actual rule. But if the GUARANTEE is what was intended, the code is wrong instead; decide which before writing.

3. "Navigation is flat ... No deep nesting, no tabs, no hamburger menus." AddWallet has three tabs and AddressDetail has a ··· menu, both deliberate, and the Screen Map now describes a navigation stack. Either soften the paragraph to match the shipped design or treat the UI as the deviation.

Implementation requirements

Verify each claim against the source before editing; do not resolve any of the three by assumption.
Items 1 and 2 have a real chance the CODE is the thing that should change. If you conclude that for either, do NOT change the code here — report it and it will be filed separately.

Definition of done

The blocklist attribution and the fetch URL agree with each other and with the intended upstream.
The token-display description matches balances.js behaviour exactly, or the discrepancy is filed as a code defect.
The navigation paragraph is consistent with the tabs, the ··· menu and the stack model.
make fmt run; markdown formatted with the repo's settings.
TODO.md updated in the same commit.
make check passes.

Found while verifying documentation against source in https://git.eeqj.de/sneak/AutistMask/issues/163 and https://git.eeqj.de/sneak/AutistMask/issues/164. All three are in `README.md` and were deliberately left alone by those units as out of their scope. **1. Phishing blocklist attribution points at the wrong upstream.** The license table cites `AugurProject/eth-phishing-detect`, but the runtime fetch URL at `src/shared/phishingDomains.js:17` points at a competitor's org fork of that repo. One of the two is wrong. This also intersects the no-competitor-names policy — resolving it may mean changing the URL rather than the attribution, so establish which upstream is intended before editing either. **2. The "no token auto-discovery" guarantee is not what the code does.** `src/shared/balances.js` displays any ERC-20 with a nonzero balance that is on the bundled list, tracked, or has at least 1,000 holders. Tokens therefore appear without the user adding them. The filtering is plainly deliberate — the code comments say so — so the likely fix is to describe the actual rule. But if the GUARANTEE is what was intended, the code is wrong instead; decide which before writing. **3. "Navigation is flat ... No deep nesting, no tabs, no hamburger menus."** AddWallet has three tabs and AddressDetail has a `···` menu, both deliberate, and the Screen Map now describes a navigation stack. Either soften the paragraph to match the shipped design or treat the UI as the deviation. ## Implementation requirements - Verify each claim against the source before editing; do not resolve any of the three by assumption. - Items 1 and 2 have a real chance the CODE is the thing that should change. If you conclude that for either, do NOT change the code here — report it and it will be filed separately. ## Definition of done - [ ] The blocklist attribution and the fetch URL agree with each other and with the intended upstream. - [ ] The token-display description matches `balances.js` behaviour exactly, or the discrepancy is filed as a code defect. - [ ] The navigation paragraph is consistent with the tabs, the `···` menu and the stack model. - [ ] `make fmt` run; markdown formatted with the repo's settings. - [ ] `TODO.md` updated in the same commit. - [ ] `make check` passes.

clawbot added this to the 1.0.0 milestone 2026-08-11 14:34:06 +02:00

clawbot referenced this issue from a commit

2026-08-11 14:40:03 +02:00

docs: correct three README claims contradicted by the code (closes #213)

clawbot referenced a pull request that will close this issue

2026-08-11 14:40:22 +02:00

docs: correct three README claims contradicted by the code (closes #213) #217

clawbot closed this issue

2026-08-11 14:41:16 +02:00

clawbot referenced this issue from a commit

2026-08-11 14:41:17 +02:00

docs: correct three README claims contradicted by the code (closes #213)