Repository navigation
Strengthen AI quant SEO signals and Pages deployability - #85
Conversation
|
@codex review |
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. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 12361c05e4
ℹ️ 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".
| assert "Google Search Console" in text | ||
| assert "gh repo view xingwudao/open-xquant" in text | ||
| def test_internal_seo_artifacts_are_not_versioned() -> None: | ||
| assert not (ROOT / "docs/seo").exists() |
There was a problem hiding this comment.
When a developer keeps private SEO notes under the newly ignored docs/seo/ path, this assertion fails even though none of those files are versioned—the exact state the ignore rule is meant to support. Check Git's tracked-file list instead of requiring the ignored directory to be absent, so the docs test suite remains usable with local internal artifacts.
Useful? React with 👍 / 👎.
1 participant
Linked Issue
Closes #84
Linked Docs / Plans
No public design or implementation plan document is linked. Internal SEO notes under
docs/seo/are intentionally excluded from version control in this PR.Public SEO-facing artifacts in this change:
README.mdwebsite/public/llms.txtwebsite/.vitepress/seo.mts.github/workflows/docs-pages.ymltests/docs/Requirement Background
After the first Chinese SEO pass, the public site existed but still had gaps in machine-readable page signals and publication operations. The repository metadata and Pages settings were updated directly outside this PR, and this branch adds code-side guardrails so the site remains easier for search engines and AI crawlers to understand.
The user also clarified that
docs/seo/should not be kept in version control.Design Constraints
AGENTS.md.mainwithout changing PR behavior.Data Flow
website/.website/.vitepress/seo.mtsderives canonical URLs, Open Graph fields, Twitter fields, and JSON-LD from each page's VitePress metadata.website/public/llms.txtis copied into the static site as an AI-readable entry-point index.website/scripts/validate_site.pyparses generated HTML and verifies required metadata, JSON-LD, sitemap, robots, and uniqueness constraints.pushorworkflow_dispatchonmain.Non-goals
AI 量化queries.docs/seo/.Compatibility
workflow_dispatchcan now deploy only when the ref isrefs/heads/main.docs/seo/,docs/infographic/, anddocs/superpowers/remain ignored internal artifact paths.Key Review Scope
llms.txtURL accuracy and AI quant positioning.docs/seo/files and related test updates.Verification Results
Passed locally:
uv run pytest tests/docs tests/contracts/test_brand_naming.py -quv run ruff check website/scripts tests/docsuv run mypy website/scriptsnpm --prefix website run docs:checknpm --prefix website run docs:buildnpm --prefix website run docs:validategit diff --check