Skip to content

docs: SEO/GEO, zh-CN site coverage, and plain performance guides - #2

Merged
lbb00 merged 10 commits into
mainfrom
seo/tech-readme-hook
Nov 5, 2026
Merged

lbb00 merged 10 commits into
mainfrom
seo/tech-readme-hook

Conversation

@lbb00

@lbb00 lbb00 commented Nov 5, 2026

Copy link
Copy Markdown
Owner

Summary

Docs-only PR on seo/tech-readme-hook (does not touch main product code).

SEO / GEO (en + zh)

  • Stronger site metadata: description, Open Graph (og:locale + alternateLocale), Twitter Card, canonical + hreflang
  • Static export forces blocking metadata into HTML (htmlLimitedBots)
  • sitemap.xml pairs en/zh; robots.txt allows common AI crawlers
  • llms.txt + llms.zh.txt; locale-aware JSON-LD
  • Post-build <html lang="zh-CN"> under /zh/; og.png
  • README: English-only value-prop hook (no Chinese in README)

zh-CN docs site

  • Complete Chinese Markdown coverage for shared docs, kit guides (guide-src/zh-CN + build-guides), package landings, corpus / evidence-policy / rule-ids, active evidence notes, and root pages published as *.zh.md
  • Tombstone evidence under evidence/_removed/ intentionally left English-only

Performance guides (en then zh)

  • Plain-docs pass: short measure-first lead, lint-hit vs wall-time scope, drop How-to-read coaching where redundant, softer bold, Lint: id (default …) lines
  • Short kits + c / js / jvm / zig English; zh-CN guide-src synced (zperf: hand zh-CN/zig-performance-guide.md)
  • build-guides / --check / doc-check OK

Commits

  • 1d31300 Improve docs site SEO metadata, sitemap, and README hook
  • e42f683 Drop Chinese from README; add GEO JSON-LD and AI crawler rules
  • 16611be Add multilingual SEO/GEO for en and zh locales
  • 941f506 docs(zh-CN): complete docs-site Chinese translation coverage
  • 5f1ea94 docs(guides): plain-English pass for short kit guides
  • 7fea5c5 docs(guides): plain-English pass for c/js/jvm/zig guides
  • c88de44 docs(guides): sync zh-CN guides to plain-English structure

Test plan

  • ./scripts/build-guides.sh
  • ./scripts/build-guides.sh --check
  • doc-check
  • Spot-check docs site en/zh pages and sitemap/hreflang after preview deploy

lbb00 added 7 commits November 4, 2026 17:44
Add description/Open Graph/Twitter/canonical/hreflang, force blocking
metadata into the static HTML export, ship sitemap.xml/robots.txt/llms.txt
and an og.png social card, and open the README with a clear EN+中文 hook.
Do not push until reviewed.
Keep README English-only. Expand llms.txt for generative engines, allow
common AI crawlers in robots.txt, and emit WebSite/SoftwareApplication
JSON-LD on every page.
Locale-aware JSON-LD and Open Graph alternates, bilingual llms.txt,
sitemap language alternates, and post-build <html lang="zh-CN"> on /zh/
so crawlers see Chinese pages correctly.
Add 简体中文 Markdown for shared docs, kit guides (guide-src/zh-CN with
build-guides stem pairing), package landings, corpus/evidence-policy/rule-ids,
active evidence notes, and root pages under zh-CN/ parents (publish as *.zh.md).
Adjust relative links for zh-CN directory depth; leave evidence/_removed English-only.
Drop How-to-read / Scope-and-method coaching lists, replace heuristic-dogfood
scope wording, integrate Lint: id (default …) lines, and sync Contents TOCs
with chapter headings across the short kit English guide-src shards.
Drop How-to-read coaching, replace heuristic-dogfood scope wording,
prefer Lint: `id` (default …) lines, soften coaching bold, and rebuild
assembled EN guides for cperf, jsperf, jvmperf, and zperf.
Mirror the EN plain-docs pass: drop How-to-read coaching where the lead
covers measure-first, replace heuristic-dogfood scope wording, prefer
Lint: `id`(默认 …) lines, soften coaching bold, and rebuild assembled
zh guides. Covers short kits, c/js/jvm guide-src/zh-CN, and zperf hand
zh-CN/zig-performance-guide.md.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-05T06:25:51.326240Z 7787452 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c88de44e51

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/zh-CN/quickstart.md Resolved
Comment thread packages/goperf/zh-CN/README.md Resolved
Codex review on #2: Chinese Markdown had every code/layout fence line
duplicated and some closers written as ```}. Collapse consecutive
identical lines in zh sources, normalize fence closers, rebuild guides,
and re-assemble site content.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 30b9ebbd5d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

siteAnchor used an ASCII-only strip that turned zh-CN fragments like
#0-范围与方法 into #0. Normalize with github-slugger instead so links
match Fumadocs heading ids.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b1c72aa888

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/zh-CN/README.md Resolved
pageHref used publishPath filenames like index.zh.md / quickstart.zh.md
as URL slugs, so zh nav became ../quickstart.zh/ instead of quickstart/.
Map published *.zh.md to public slugs without .zh, treat index.zh.md as
an index page, and guard with pageHref asserts plus a post-assemble
locale-slug check.
@lbb00
lbb00 merged commit d9a44cb into main Nov 5, 2026
22 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