Skip to content

docs: update AI skill data output docs#1653

Open
yifancong wants to merge 1 commit intomainfrom
docs/ai
Open

docs: update AI skill data output docs#1653
yifancong wants to merge 1 commit intomainfrom
docs/ai

Conversation

@yifancong
Copy link
Copy Markdown
Contributor

Summary

docs: update AI skill data output docs

Related Links

Copilot AI review requested due to automatic review settings May 9, 2026 05:18
Copy link
Copy Markdown

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

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: 23b4d7dd49

ℹ️ 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 packages/document/docs/en/guide/start/ai.mdx
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the AI documentation to better explain how to produce the JSON analysis data (rsdoctor-data.json) consumed by the rsdoctor-analysis Agent Skill.

Changes:

  • Documented the output.mode: 'brief' + output.options.type: ['json'] configuration needed to generate rsdoctor-data.json.
  • Added an environment-variable-based alternative (RSDOCTOR_OUTPUT='json') for JSON output (but this appears unsupported in the current codebase).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
packages/document/docs/zh/guide/start/ai.mdx Adds guidance for generating rsdoctor-data.json for the rsdoctor-analysis skill (includes env var note).
packages/document/docs/en/guide/start/ai.mdx Same as above for English docs (includes env var note).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/document/docs/en/guide/start/ai.mdx
Comment thread packages/document/docs/zh/guide/start/ai.mdx
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying rsdoctor with  Cloudflare Pages  Cloudflare Pages

Latest commit: 23b4d7d
Status: ✅  Deploy successful!
Preview URL: https://087a5ce8.rsdoctor.pages.dev
Branch Preview URL: https://docs-ai.rsdoctor.pages.dev

View logs


- [rsdoctor-analysis](https://github.com/rstackjs/agent-skills#rsdoctor-skills): Use Rsdoctor for build analysis and provide optimization recommendations.

The `rsdoctor-analysis` skill analyzes the data in `rsdoctor-data.json`. You can generate this file by setting `output.mode` to `'brief'` and `output.options.type` to `['json']`:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does this mean we need to manually adjust the configuration before using the skill? This seems not user friendly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants