Repository navigation
docs(overviews): benefit-first overview pages for tg, max, wa, zm and mail in EN/RU/ES - #672
Merged
Merged
Conversation
… mail in EN/RU/ES
The five site-owned overviews were routing hubs: setup first, a long guide
table, no gains, no proof, no comparison link. Each page now follows the
overview template from the docs-marketing plan:
- an opening that names the reader's gain, then a numbered "On this page"
- "What you get" (5 to 7 gains with a fact each)
- "Things a newcomer would not guess" (profile word, nothing marked read or
sent, the local copy and what an empty offline search means)
- a You/Agent example with a source and a write the user approves
- "Why <tool>" with facts from the tool's comparison page, a link to it and
one fair line on when another tool fits better
- what it can do by task, how it works, a five-minute start, limits, and a
task-to-guide table
Every claim was checked against the tool's docs at the docsRef pin
(content/upstream after pnpm sync) and the comparison pages, except two mail
facts taken from mail-cli main (4 commits past the pin): the first sync reads
30 days by default, and Gmail empties Trash after 30 days. Dropped or
narrowed: "search forgives typos" (max), "every change can be undone"
(mail: a deleted draft does not come back, Gmail empties Trash after 30
days), wa's "not checked against real WhatsApp" line, zm's ffmpeg and
"speakers unknown" limits, the zm quick start placeholder (WC-DOC-12; it now
links First run instead), and wa's server install (it starts nothing, so
the page names install and start, macOS and Linux only).
Russian and Spanish are written as native text with the search phrases
from the SEO keyword map. Russian avoids the letter yo, guillemets,
semicolons and long dashes. max.ru states the user agreement risk once,
plainly, with a link to security.
Titles: toolTitles for the five tools now lead with the search phrase
("Telegram MCP server and CLI for your own account" and so on). Meta
descriptions are new gains with a fact. The Zoom sidebar label loses its
long dash. The docs start page no longer calls mail read only. The Zoom
browser test follows the new H1.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Nov 17, 2026
leemour
added a commit
that referenced
this pull request
Nov 17, 2026
…on (#674) The deploy after #672 was skipped: browser shard 2 failed 12 times in `tests/file-attachments.spec.ts` ([run](https://github.com/WireCatLabs/cli-docs/actions/runs/44119615422)). The missing icons were `/docs/google-meet`, `/docs/telemost` and (RU) `/docs/beeline`. #673 gave them their own logos as `<img alt="">` (`ServiceLogo` in `components/brand-icons.tsx`), and the test only looked for `svg[aria-hidden="true"]`. The logo is decorative in the same way, so the test now accepts `svg[aria-hidden="true"], img[alt=""]`. No site change. Full validation is dispatched on this branch, which runs this spec. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
leemour
added a commit
that referenced
this pull request
Nov 17, 2026
…ywords in EN, RU and ES (#675) Search engines and AI answer engines read a page's `<title>`, H1 and description first. Ours hid the phrase people type: tool pages said "Connect Bitrix24 CRM to your AI agent" instead of "Bitrix24 MCP server", subpages put a generic word first with a long dash ("The MCP server — Telegram", "Install — Notion"), and the Notion landing was just "Notion". This PR puts the product and "MCP server" or "CLI" first in EN, RU and ES. ## Approach - **Tool landings** (`toolTitles` in `lib/seo-copy.json`): the keyword set from the docs-marketing plan for all 11 tools, Notion added. tg, max, wa, zm and mail keep the titles #672 merged. - **Tool subpages:** new `pageTitles` templates per locale, with per-tool overrides, used by `documentationTitle` in `lib/seo.ts` for both the H1 and `<title>`. For example "Install the Notion CLI and MCP server", "Telegram MCP server setup for Claude Code, Codex and Cursor", "Download and export Telegram chat history". Pages without a template read "Telegram: People", with no long dash. - **Descriptions:** new `pageDescriptions` (140 to 160 characters, keyword once) for the memo, b24, pbx and gcal overviews and every MCP page. They are checked before the synced frontmatter. - **Site pages:** keyword titles such as "Connect your AI agent to your chats, mail and documents" (was "Start here"). The old short name stays as `sidebarTitle`, so the menu does not change. The 9 pages that `docs:opening` now re-checks got their "On this page" lists and wording fixes. - **Markdown copies** (`/llms.mdx/...`) carry the same title as the HTML page. - All 805 page titles stay unique per language. Browser specs follow the new H1s. Query choices were checked against Google autocomplete in each language: "telegram mcp server", "mcp telegram claude code", "export telegram chat history", "google drive mcp", "notion mcp", "bitrix24 mcp" / "битрикс24 mcp", "obsidian mcp", "exportar chat de telegram". ### Examples | Page | Before | After | |---|---|---| | en `tg/mcp` | The MCP server — Telegram | Telegram MCP server setup for Claude Code, Codex and Cursor | | en `notion/installation` | Install — Notion | Install the Notion CLI and MCP server | | ru `b24` | Подключите CRM Bitrix24 к ИИ-агенту | Битрикс24 MCP-сервер и CLI для CRM | | ru `tg/search` | Поиск — Telegram | Поиск сообщений и переписки в Telegram | | es `notion` | Notion | Servidor MCP y CLI de Notion con búsqueda sin conexión | | es `drive/installation` | Instalar y conectar — Google Drive | Instala la CLI y el servidor MCP de Google Drive | ## Left out - **Overview descriptions for tg, max, wa, zm, mail, drive and notion:** written in #672 and the documents PR #668. Not overridden here. - **Home page title** (`homeTitle`): unchanged. Proposal: lead with "Local MCP servers for your AI agent" and drop the long dash. - **voip, beeline:** handled by #670. - **Compare pages:** a generic "<Product> MCP servers and CLIs compared" for now. Titles naming rivals need each page read. - **Contributor pages** (architecture, testing, build-*), except "Create your CLI": low search value. - **Proposed titles, not applied:** | Page | EN | RU | ES | |---|---|---|---| | `markdown` (#668) | Obsidian and Markdown notes MCP server for AI agents | MCP-сервер для заметок Obsidian и Markdown | Servidor MCP para notas de Obsidian y Markdown | | `ydisk` (#668) | Yandex Disk MCP server: search your files with AI | MCP-сервер Яндекс Диска: поиск по файлам для ИИ-агента | Servidor MCP de Yandex Disk para tu agente de IA | | `people` | People in your Telegram and MAX chats | Люди в ваших чатах Telegram и MAX | Personas en tus chats de Telegram y MAX | | `tasks` | Tasks and promises from your chats | Задачи и обещания из ваших чатов | Tareas y promesas de tus chats | | `first-tasks` | First tasks to ask your AI agent | Первые задачи для ИИ-агента | Primeras tareas para tu agente de IA | people, tasks and first-tasks were left as they are because a retitle makes `docs:opening` check the whole page, and these need a contents list and wording fixes first. ## Checks Local: `pnpm lint`, `pnpm typecheck`, `pnpm exec vitest run scripts lib` (520 passed), `pnpm docs:check`, `pnpm check:links --source`. `next build` was not run locally (memory limit on this machine). The browser specs did not run locally because the dev server would not start, so CI runs them. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Readers of the tg, max, wa, zm and mail overviews could not see what the tool gives them: the pages opened with setup and a guide table. Each overview is now a benefit-first page in EN, RU and ES, following the overview template from the docs-marketing plan (cli-private
plans/2026-11-17-docs-marketing/overview-template.md).What changed per tool
Every page now has: an opening that names the reader's gain, a numbered "On this page", What you get (gains with a fact each), Things a newcomer would not guess, a You/Agent example, Why with facts from the comparison page plus a link to it and one "fits better" line, what it can do by task, How it works, a start, Limits and a task-to-guide table.
wa/botandwa/permissionslinks the browser test needs.server install+server startnamed correctly (install alone starts nothing, macOS and Linux only).remote-meetings updatethe user approves. Quick start no longer has the<public-client-id>placeholder (WC-DOC-12): it installs, then links First run.session startruns without--address(it asks at a terminal).tests/zoom-docs.spec.ts: follows the new Zoom H1.Titles (
lib/seo-copy.json→toolTitles, the HTML H1 and<title>)Titles are the SEO set from cli-private
seo-keywords.md. Meta descriptions (frontmatter) are new: a gain plus a fact, different from the opening.Reviewer checklist (template's 11 points), per page
Checked on each page in EN, RU and ES.
docsRefpin;, long dashes,ё, guillemets, hype wordsdocs:openingpasses (run on the files by name, since it only scanscontent/docs)Claims dropped or narrowed as unverifiable at the pin: "search forgives typos" (max), "every change can be undone" (mail), "speakers stay unknown" and "needs ffmpeg" (zm), "some of it is not checked against real WhatsApp" (wa, also editorial history per AUTHORING), "only to the people you choose" for tg auto-replies (narrowed: replies go to everyone a rule matches unless you limit the audience). From mail-cli main, not the pin (4 commits apart): the first sync reads 30 days by default (
src/commands/sync.ts), Gmail empties Trash after 30 days.Checks run locally
pnpm lint,pnpm search:check,pnpm docs:release-notes,pnpm docs:contracts,pnpm docs:check,pnpm check:links --source,pnpm test(515 passed),pnpm typecheck,docs:openingon the 15 overview files by name.pnpm docs:spellfails on main already (55 issues in other files, none in changed files) and is not in CI.next buildwas not run locally (memory cap on this machine); the Full validation workflow is dispatched on this branch for the build, links, SEO and browser tests.Not touched: drive, notion and Documents & files (#668, #669), and b24, gcal, memo, pbx.
🤖 Generated with Claude Code