Skip to content

docs: README language switcher + Powered by EMRG + concise current-state docs (rants 2026-08-22T07:46:46/07:49:58/07:51:36) - #119

Merged
argszero merged 1 commit into
mainfrom
docs/doc-refresh
Aug 22, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/doc-refresh

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Documentation refresh wave (3 rants, all docs):

  1. README language switcher (rant 07:46:46) — [English](README.en.md) | [简体中文](README.md) links added at the top of both READMEs so GitHub renders the language switcher on the repo page
  2. Docs restructure — current state + roadmap, not history (rant 07:49:58):
    • docs/architecture.md (158→90 lines): removed version-history header; now current tech stack (Rust + axum + SQLite + native JS frontend), modules, data flow, real DB tables, API list, and a roadmap section with clearly-marked not-implemented items (PostgreSQL/Redis/React/Tauri)
    • docs/plan-api-matrix.md (135→35 lines): condensed from research notes to protocol-support status (3 endpoints + SSE, client setup, upstream providers, model catalog)
    • docs/user-stories.md (389→52 lines): condensed from interview-style stories to roles, core flows, and capability checklist
    • CONTRIBUTING.md: verified current; added a short rant-driven development flow section
  3. Powered by EMRG (rant 07:51:36) — "Powered by EMRG" section added to both READMEs (before License) and the contributing guide documents the rant → PR → merge flow

Related Rants

  • 2026-08-22T07:46:46 — GitHub README 缺少语言切换(zh/en 双版本无法互切)
  • 2026-08-22T07:49:58 — 文档体系重写:简洁清晰,说明现状与规划未来(不是记录历史)
  • 2026-08-22T07:51:36 — 补充:README / 文档添加「Powered by EMRG」标识

Tests

  • Docs-only change: cargo test 139/139 passed, fmt --check clean (unchanged code)

Acceptance

  • GitHub repo page shows zh ↔ en language switcher
  • Each doc ≤120 lines, 1-minute read of the core
  • No version-history remnants (CHANGELOG.md owns history)
  • "Current state" matches the code (SQLite/native JS, not PostgreSQL/React)
  • Roadmap items explicitly marked as not implemented
  • Powered by EMRG in both READMEs with link

…ate docs (rants 2026-08-22T07:46:46/07:49:58/07:51:36)
@argszero
argszero merged commit 6d87213 into main Aug 22, 2026
1 check passed
@argszero
argszero deleted the docs/doc-refresh branch August 22, 2026 00:06
argszero added a commit that referenced this pull request Sep 13, 2026
Two rendered strings in `ui/js/i18n.js` point at material that the
2026-08-22 docs flattening deleted:

- `wallet.raise.sub` / `admin.raise.sub` carry the requirement id
  `US-20`. Commit 6d87213 (#119) rewrote docs/user-stories.md into a
  current-state doc and dropped every `US-<n>` id, so `US-20` resolves
  nowhere: `grep -rn 'US-[0-9]' docs/ README.md README.en.md` is empty at
  HEAD. Every other `US-` id in the repo lives in a code comment or in
  ui/README.md; these were the only ones shown to users.
- `mk.detail.routeVal` cites 「架构 v0.2 路由策略」. The same commit
  deleted the `4.2.1 路由与故障转移策略(v0.2)` section from
  docs/architecture.md, and that file has no version stamp left.

One root cause, two pointer shapes: #179 fixed the `§N` references the
flattening broke and #216 the `file:line` ones, but the `name + stamp`
shape (`US-20`, `v0.2`) was never audited.

The pack values are now plain prose (both sentences were already
self-contained), each edited static fallback in ui/index.html is kept
byte-equal to its pack value, and the three ui/README.md lines that cited
the deleted section are re-pointed at the section that carries the
content today (docs/architecture.md §3, the `router.rs` row), in the
style of #179.

`ui/` text only: no Rust change, no i18n key added or removed (786/786
before and after), no new T() call sites or data-i18n attributes. i18n.js
content changed, so its cache-bust is bumped (20260912-5 -> 20260914-4).

Co-authored-by: argszero <argszero@argszerodeMac-mini.local>
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