Skip to content

docs: architecture guide, shared security page, footer links - #41

Merged
leemour merged 5 commits into
mainfrom
docs/architecture
Oct 4, 2026
Merged

leemour merged 5 commits into
mainfrom
docs/architecture

Conversation

@leemour

@leemour leemour commented Oct 4, 2026

Copy link
Copy Markdown
Owner

Task

The owner asked for a public architecture guide (packages, layers, adapters, key patterns, diagrams — showing how it works, not selling), a footer that sends problem reports to the support chat and security to a shared page, and a shared security page that the tg and max pages point to.

Why

Architecture material existed only in developer files in three repositories. The footer sent "Report a problem" to tg-cli's GitHub issues and "Security" to tg's own page. No repository had a private way to report a vulnerability.

What

  • /{lang}/docs/architecture (en, ru, es): packages, one command from start to finish, five layers, the adapter contract, the local store, patterns, the MAX side, testing, limits and trade-offs, where to start contributing. Source links pinned to commits (cli-messaging c7cd479, cli-core 8648e39, tg-cli 4a36e85, max-cli fff19ff).
  • components/architecture-diagram.tsx: box diagrams drawn from data, so labels follow the page language and colours the theme; stacks at phone width. Prose under each diagram says the same thing for the Markdown copies agents read.
  • /{lang}/docs/security (en, ru, es): what both tools share — the local store, the send guard, permissions and MCP confirmations, other people's text, the network, and private vulnerability reporting (hello@wirecat.dev or GitHub private reporting, now enabled on tg-cli, max-cli, cli-messaging, cli-core and cli-docs).
  • Footer and About: "Report a problem" → https://t.me/wirecatdev, "Security" → /{lang}/docs/security. Changed in the prototypes and export script, re-exported; the JSON diff touches only those two links.
  • scripts/localize.ts siteLinks: a tool page that links https://wirecat.dev/<lang>/docs/... opens it in the reader's language after sync. Tested.
  • Plan: docs/plans/2026-10-04-architecture-and-security.md.

Related tool PRs: leemour/tg-cli#257, leemour/max-cli#387, leemour/cli-messaging#492. The trimmed tool security pages reach the site with each tool's next release; their translations then need a review.

Testing

  • pnpm lint && pnpm typecheck && pnpm test — 148 tests pass.
  • pnpm sync && pnpm exec next build && pnpm check:links — links ok.
  • Screenshots of /en|ru|es/docs/architecture and /ru/docs/security in light, dark and at 390 px: no horizontal scroll; footer links verified in the built page.

🤖 Generated with Claude Code

@leemour
leemour force-pushed the docs/architecture branch from b474357 to b6a3568 Compare October 4, 2026 11:32
leemour and others added 5 commits October 4, 2026 13:44
Plan for review: a shared architecture guide with per-language diagrams,
a shared security page that the tg and max pages point to, and footer
links to the support chat and that page.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…red page

"Report a problem" pointed at tg-cli's GitHub issues and "Security" at
tg's own page. Both now lead to the support chat and the shared security
page, in the landing prototypes, the export and the About page.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
What both tools share: the local store, the send guard, permissions and
MCP confirmations, other people's text, the network, and how to report a
vulnerability privately (email or GitHub private reporting). Messenger
details stay on each tool's page.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Packages, the path of one command, the five layers, the adapter contract,
the local store, the patterns, the MAX side, testing and the limits, in
English, Russian and Spanish, with source links pinned to commits.

Diagrams are drawn from data, so labels follow the page language and
colours the theme. Tool pages that link a site page by its full URL now
open it in the reader's language after sync.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…curity table

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@leemour
leemour force-pushed the docs/architecture branch from 3b66452 to 7ab8e7b Compare October 4, 2026 11:44
@leemour
leemour merged commit 34dab35 into main Oct 4, 2026
6 checks passed
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