Skip to content

docs(readme): rewrite the tagline and surface the live instance - #239

Merged
argszero merged 1 commit into
mainfrom
docs/readme-tagline-and-live-url
Sep 14, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/readme-tagline-and-live-url

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Addresses host rant 2026-09-14T20:32:17 (README 标语读起来不通顺、也没有吸引力,且没有放线上实例地址).

① Tagline (both README.md and README.en.md) — three defects fixed together: the dropped subject (「需要时」需要什么?), the vague object (「用别人的」= 别人的什么?), and the missing "exchange" benefit (the reader's gain was never stated). The new line names the object explicitly and states the value proposition.

② Live instance — the READMEs previously mentioned no online address at all. Added https://aitokenpool.args.fun/ in two places: a prominent line under the language switcher, and a "no install needed" path at the top of Quick Start.

③ Line 25 restated sentence (both files) — same sentence-pattern problem as ①, rewritten in the same voice so the two occurrences stay consistent (otherwise fixing one makes the other more jarring).

Related Issue

No linked issue. Driven by rant timestamp 2026-09-14T20:32:17 (project aitokenpool).

Changes

  • Docs only; no behaviour change
  • No ATP_MASTER_KEY= literal form added — src/deploy_gate.rs include_str!s both READMEs, and this change adds none (the only remaining ATP_MASTER_KEY= occurrences are the pre-existing $(openssl rand -hex 32) examples, classified NotALiteral)

Tests

  • cargo test all pass — 249 passed; 0 failed
  • cargo fmt --check passes
  • deploy_gate (which reads both READMEs) passes — 3 passed
  • zh/en parity checked: both files stay at 80 lines; tables and anchors unchanged

Checklist

  • Branch naming follows the convention (docs/)
  • Commit message uses Conventional Commits
  • Single responsibility, minimal change

Host rant 2026-09-14T20:32:17: the opening tagline read poorly and had no
appeal, and the README never mentioned any live URL.

- Tagline (both README.md and README.en.md): restore the dropped subject,
  name the object explicitly ("models shared by others"), and state the
  benefit readers actually get (redeem points for others' models). The
  vague comparison is replaced with the exchange value proposition.
- Use-case table line 25 (both files): same sentence-pattern problem,
  rewritten in the same voice so the two occurrences stay consistent.
- Add the live instance https://aitokenpool.args.fun/ in two places: a
  prominent line under the language switcher, and a no-install path at
  the top of Quick Start.

Docs only; no ATP_MASTER_KEY= literal form added (deploy_gate stays
green); zh/en line counts remain equal (80/80).
@argszero
argszero merged commit cefd589 into main Sep 14, 2026
1 check passed
@argszero
argszero deleted the docs/readme-tagline-and-live-url branch September 14, 2026 13:17
@argszero argszero mentioned this pull request Sep 14, 2026
9 tasks
argszero added a commit that referenced this pull request Sep 14, 2026
Ships two changes since v0.7.23 (#239, #240):

- #240: the transactions summary/COUNT/trend statements joined keys/users/
  api_keys unconditionally, which made SQLite drop the covering index and
  fall back to a row-by-row lookup (0.21s -> 22.6s on the dev db, 186k rows
  over NFS). That query held the shared DB lock long enough to queue
  /api/me and /api/models behind it, and the boot session restore waits for
  all four requests, so a refresh could sit on the login page with the token
  intact. The joins are now conditional on a column filter actually needing
  them.
- #239: README tagline rewritten and the live instance surfaced.

No schema change (12 -> 14 happened in v0.7.23).
- Cargo.toml / Cargo.lock: 0.7.23 -> 0.7.24.
- ui/index.html: asset cache-bust -> 20260914-11 (all five refs).
- CHANGELOG.md: v0.7.24 entry.

Gates: `cargo test` 249 passed / 0 failed, `cargo fmt --check` clean.
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