Skip to content

Improve Chinese SEO for AI quant discovery - #83

Merged
xingwudao merged 13 commits into
mainfrom
seo-ai-quant-optimization
Sep 2, 2026
Merged

xingwudao merged 13 commits into
mainfrom
seo-ai-quant-optimization

Conversation

@xingwudao

Copy link
Copy Markdown
Owner

Linked Issue

Closes #82

Linked Docs / Plans

No public design-plan document is linked because internal planning artifacts under docs/superpowers/ are intentionally excluded from version control.

Public documentation added or updated in this branch:

  • README.md
  • docs/seo/release-runbook.md
  • website/
  • tests/docs/

Requirement Background

Chinese search queries around AI 量化, AI 量化框架, 量化 Agent, strategy backtesting, factor research, robustness checks, audit, and live trading should have stronger crawlable signals for open-xquant.

The repository had strong implementation substance, but its search-facing pages were mostly English or not structured around Chinese intent clusters.

Design Constraints

  • Keep canonical naming consistent with AGENTS.md.
  • Keep SEO pages deterministic and testable.
  • Avoid committing internal planning artifacts or generated source notebooks.
  • Keep formally referenced images under docs/images/.
  • Use generated docs only where scripts can verify freshness.
  • Do not change strategy runtime behavior.

Data Flow

  • website/scripts/generate.py reads skill and CLI metadata.
  • Generated markdown pages are written under website/skills/ and website/reference/.
  • VitePress builds the Chinese docs site from website/.
  • website/scripts/validate_site.py validates generated static output under website/.vitepress/dist.
  • GitHub Pages workflow builds and deploys the docs site from the same commands.

Non-goals

  • No changes to trading logic, broker integrations, or backtest engines.
  • No external analytics vendor integration.
  • No paid acquisition or off-site content campaign.
  • No repository settings change from code; the GitHub description still needs manual update after merge.

Compatibility

  • Python tests continue to run through uv.
  • VitePress is pinned to 1.6.4.
  • The docs package declares Node >=22 <23.
  • Existing docs image references are preserved through the new docs/images/ paths.

Key Review Scope

  • Chinese SEO positioning in repository metadata and README copy.
  • Generated skill and CLI topic pages for crawlability.
  • Technical SEO assets: sitemap, robots, canonical metadata, 404 page, and workflow.
  • Cleanup of docs/infographic/ and docs/superpowers/ from tracked files.
  • Guardrails that prevent stale generated docs and forbidden naming regressions.

Verification Results

Passed locally:

  • uv run pytest tests/docs tests/contracts/test_brand_naming.py tests/contracts/test_operator_distribution_schemas.py -q
  • uv run ruff check website/scripts tests/docs tests/contracts/test_operator_distribution_schemas.py
  • uv run mypy website/scripts
  • npm --prefix website run docs:check
  • npm --prefix website run docs:build
  • npm --prefix website run docs:validate
  • git diff --check

@xingwudao

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 2, 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-09-02T05:43:31.073597Z eb7e6d1 Manual request
ℹ️ 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.

@xingwudao
xingwudao merged commit 2dc5148 into main Sep 2, 2026
2 checks passed

@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: eb7e6d17d0

ℹ️ 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 on lines +27 to +29
concurrency:
group: pages
cancel-in-progress: true

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Separate PR checks from deployment concurrency

Use an event-specific concurrency group or disable cancellation for production deployments. With one shared pages group and cancel-in-progress: true, any pull-request run started while a main build or deploy is running cancels that production workflow; because the replacement PR run skips artifact upload and deployment, the merged documentation can remain unpublished until another main push or manual intervention.

Useful? React with 👍 / 👎.

Comment on lines +17 to +21
- "pyproject.toml"
- "agent/skills/**"
- "website/**"
- "tests/docs/**"
- ".github/workflows/docs-pages.yml"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Trigger documentation checks for CLI source changes

Add the CLI source tree (at least src/oxq/cli/**) to both event path filters. website/scripts/generate.py imports oxq.cli.main and derives the committed tools index from its leaf commands, but a PR or main push that only adds, removes, renames, or edits a CLI command does not run docs:check or rebuild Pages, allowing website/tools/index.md and the deployed site to remain stale.

Useful? React with 👍 / 👎.

Comment on lines +73 to +74

```bash

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove unapproved topics before adding the approved set

Ensure existing topics are validated or removed before this update. When the repository already contains any topic outside the approved list, repeated --add-topic flags retain it—the installed gh repo edit --help explicitly distinguishes “Add repository topic” from --remove-topic—so Gate 5 cannot produce the exact topic contract; Gate 6 then detects the mismatch only after the description and homepage have already been mutated, without restoring the prior metadata.

Useful? React with 👍 / 👎.

@xingwudao
xingwudao deleted the seo-ai-quant-optimization branch September 2, 2026 05:43
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.

Improve Chinese SEO for AI quant discovery

1 participant