Skip to content

docs: landing README — banner hero, badges, synced translations (RU/ES + new ZH) - #52

Merged
AbsoluteMode merged 1 commit into
mainfrom
claude/readme-formatting-b36f2b
Aug 3, 2026
Merged

docs: landing README — banner hero, badges, synced translations (RU/ES + new ZH)#52
AbsoluteMode merged 1 commit into
mainfrom
claude/readme-formatting-b36f2b

Conversation

@AbsoluteMode

Copy link
Copy Markdown
Owner

What

Reworks the README into the landing-style page drafted on codex/landing-readme, and brings all four language versions to identical content: English (reference), Русский, Español, and a new 中文 translation.

English master

  • Landing skeleton from the Codex draft: hero banner, badges, capability/tool tables, two mermaid diagrams, collapsible details for per-agent install, transports, licensing.
  • One hero image instead of logo + banner — the OG card already carries the logo and tagline. Recompressed site/public/og.png (1.7 MB) → assets/og.webp (106 KB, visually identical), committed on this branch so the README doesn't depend on the site branch merging.
  • Folded back load-bearing content from main that the draft had dropped: model licensing notes (CC BY-NC trap), the manual SessionStart hook JSON, all three team-mode transports (shared folder / LAN relay / internet relay + Caddy), metadocs directory structure and server-side mechanics, sidechain skipping, vector reuse, Cursor 2.5+ requirement, setup --lang --yes.
  • Team mode kept as a full, prominent section (dialogue example + mechanics + transports) per earlier feedback that it was underrepresented.
  • Dropped the stars badge; kept license / python / MCP / tests with the brand colors.
  • Every CLI command and flag verified against src/session_recall/ (--scope, share/metadocs subcommands, health output format).

Translations

  • docs/README.ru.md, README.es-ES.md rewritten to mirror the master 1:1; README.zh-CN.md added.
  • All 4 files: 15 sections, 8 details blocks, 42 code fences — code/console/mermaid blocks byte-identical to the master; language switcher + "English is the reference" note in each translation.
  • Internal anchors point at translated headings (GitHub preserves Cyrillic/CJK/accents in slugs) — verified rendered on this branch: all anchors resolve, all images load, both mermaid diagrams render, no broken emphasis around CJK punctuation.

Notes

  • The Spanish community translation is superseded by the synced version; the original contribution stays in git history.
  • session-recall.es-ES credit line and the old RU-only structure are replaced by the unified layout.

🤖 Generated with Claude Code

…nslations

The English README takes the landing structure drafted on
codex/landing-readme (hero banner, badges, tool/capability tables,
mermaid diagrams, collapsible details) and folds back the load-bearing
content from main that the draft dropped: model licensing notes, the
manual SessionStart hook, team-mode transports, metadocs mechanics,
sidechain skipping, vector reuse.

One hero image instead of logo + banner (the banner already carries
both), stars badge dropped, og.webp recompressed from the 1.7 MB PNG
to 106 KB at visually identical quality and committed under assets/ so
the README does not depend on the site branch merging.

All four language versions now carry identical content and a shared
language switcher: English (reference), Русский, Español, and new 中文.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@AbsoluteMode
AbsoluteMode merged commit 23fc95f into main Aug 3, 2026
8 checks passed
@AbsoluteMode
AbsoluteMode deleted the claude/readme-formatting-b36f2b branch August 3, 2026 16:09
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.

2 participants