Repository navigation
docs: SEO/GEO, zh-CN site coverage, and plain performance guides - #2
Conversation
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.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 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".
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.
There was a problem hiding this comment.
💡 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.
There was a problem hiding this comment.
💡 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".
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.
Summary
Docs-only PR on
seo/tech-readme-hook(does not touchmainproduct code).SEO / GEO (en + zh)
og:locale+alternateLocale), Twitter Card, canonical + hreflanghtmlLimitedBots)sitemap.xmlpairs en/zh;robots.txtallows common AI crawlersllms.txt+llms.zh.txt; locale-aware JSON-LD<html lang="zh-CN">under/zh/;og.pngzh-CN docs site
guide-src/zh-CN+build-guides), package landings, corpus / evidence-policy / rule-ids, active evidence notes, and root pages published as*.zh.mdevidence/_removed/intentionally left English-onlyPerformance guides (en then zh)
Lint: id (default …)lineszh-CN/zig-performance-guide.md)build-guides/--check/doc-checkOKCommits
1d31300Improve docs site SEO metadata, sitemap, and README hooke42f683Drop Chinese from README; add GEO JSON-LD and AI crawler rules16611beAdd multilingual SEO/GEO for en and zh locales941f506docs(zh-CN): complete docs-site Chinese translation coverage5f1ea94docs(guides): plain-English pass for short kit guides7fea5c5docs(guides): plain-English pass for c/js/jvm/zig guidesc88de44docs(guides): sync zh-CN guides to plain-English structureTest plan
./scripts/build-guides.sh./scripts/build-guides.sh --checkdoc-check