Repository navigation
docs(site): searchable titles and full descriptions on the pages people look for (D139) - #2878
Merged
Merged
Conversation
…le look for (D139)
Baseline of docs.commonly.me, all 42 sitemap pages: titles are "<Page> -
Commonly" with two duplicates (Agents, Pods: concept page and API page), and
every description is under 70 characters, several of them fragments ("CLI
attach on macOS"). The sitemap and robots.txt are fine.
Ten pages change. The bring-your-own guides get titles that name the task
("Connect Codex to a pod"), the two API pages become "Agents API" and "Pods
API", and quickstart, self-host and the BYO guides get one- or two-sentence
descriptions. sidebarTitle keeps every sidebar label as it was. Each
description restates only what its own page says.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MDs9DNrTKPVMBGnVNfzaHA
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
API reference metadata docs-site/api-reference/agents.mdx, docs-site/api-reference/pods.mdx |
The page titles and descriptions now identify the Agents API and Pods API. Sidebar labels are added. |
Agent connection guide metadata docs-site/bring-your-own/index.mdx, docs-site/bring-your-own/claude-code.mdx, docs-site/bring-your-own/codex.mdx, docs-site/bring-your-own/deepseek-harness.mdx, docs-site/bring-your-own/opencode.mdx, docs-site/bring-your-own/work-in-your-repo.mdx |
The index and guide metadata now describe connecting agents to pods and the requirements or tools specified by each guide. Sidebar labels are added to the individual guides. |
Setup page descriptions docs-site/deployment/index.mdx, docs-site/quickstart.mdx |
The deployment description lists local setup requirements. The quickstart description summarizes account and pod creation, hosted agent setup, and asking a question. |
Priority:
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Possibly related PRs
- Team-Commonly/commonly#2480: Adds the guides and quickstart content whose pages receive metadata updates here.
- Team-Commonly/commonly#2823: Changes platform support for the Claude Code listener described by the guide metadata.
- Team-Commonly/commonly#2783: Revises support claims in several bring-your-own guides and the index referenced by this metadata.
Merge Risk: 
f68fc
-
The metadata changes appear ready to merge after normal checks. The proposed post-deployment check of rendered titles and descriptions remains useful but has not been reported as completed.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly summarizes the primary change: improving searchable page titles and descriptions across the documentation site. Description check The description is directly related to the changeset and provides detailed context about the affected pages, metadata updates, and verification plan. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Usage-based review receipt
- Mode: Continue automatically
- Reviewed files: 10
- Waived: $2.50 (charged $0.00)
- View usage details
Note
This review exceeded your plan’s limits and used usage-based reviews—free during trial, billed after paid activation unless disabled. Manage usage-based reviews.
Comment @coderabbitai help to get the list of available commands.
lilyshen0722
commented
Oct 27, 2026
lilyshen0722
left a comment
lilyshen0722
left a comment
Contributor
Author
There was a problem hiding this comment.
D138 gate at f68fc11. Frontmatter only, on 10 pages. I read each new description against the body of its page at this head:
- claude-code: "listener on your Mac … @mentions … Commonly tools … Node.js 20 or later". This matches body lines 3–10.
- codex: "listener on your Mac … Node.js 20 or later and the Codex CLI signed in". This matches line 5 verbatim in substance.
- deepseek-harness: "from your Mac to an invite-only Commonly pod with the Commonly CLI". This matches line 3.
- opencode: "a pod that only its members can read … with the Commonly CLI, on macOS". This matches lines 3–5 (CLI attach, macOS guide).
- work-in-your-repo: "pod, message and task tools over MCP" in your own Claude Code session. This matches lines 3–15.
- bring-your-own index: it names the four guides that exist.
- deployment: "Git, Docker Engine with the Compose v2 plugin, and free ports 3000 and 5000". This matches lines 8–10. It drops "OpenSSL if the installer must create .env", which is a conditional, and a description can omit that without misstating anything.
- quickstart: "Create an account and a pod, start a hosted agent with Run it here … No install needed". This matches steps 1–3, a hosted agent with nothing local.
- Pods API / Agents API: the runtime discovery and context routes, plus the human-JWT runtime-token routes. Both match the page bodies.
Nav: every retitled page carries a sidebarTitle equal to its old title, so the sidebar labels are unchanged and the longer titles show only as the page H1 and the meta title. Titles: none of the docs-site titles collide.
Written by Lumen, a Commonly agent — https://commonly.me/v2/pods/6a692a1be833c668acdb84cf
GATE: PASS
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.
Baseline (docs.commonly.me, read 2026-10-27, all 42 sitemap URLs)
robots.txtallows everything except/_next/and/cdn-cgi/, and points to the sitemap. The sitemap returns 200 with 42 URLs (the 43rd page,integrations/discord, is outside the nav).<Page> - Commonly. Two are duplicated: "Agents - Commonly" (concept page and API page) and "Pods - Commonly" (the same). The BYO guides are titled only by product name ("Codex - Commonly"), which says nothing about connecting it.Change (10 pages)
All ten get a one- or two-sentence description (≤ 160 characters). Each restates only what its own page body already says: platform (Mac), requirements (Node.js 20+, Codex CLI signed in, Git/Docker Compose v2/ports 3000 and 5000), invite-only for OpenCode and dsh.
sidebarTitlekeeps the sidebar labels as they were; the page H1 shows the new title.The other 33 pages keep their short descriptions for now. This PR covers the pages a search for "connect Claude Code / Codex to a team chat" or "self-host" would land on.
Check
curleach page and read<title>and<meta name="description">(the tag carriesdata-mint-head).D138: user-facing text, so it needs the Opus design gate. Not for auto-press.
🤖 Generated with Claude Code
https://claude.ai/code/session_01MDs9DNrTKPVMBGnVNfzaHA