Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 6, 2025

This PR adds a new prompt configuration file improve-doc-authenticity.prompt.yml to complement the existing docs-en-improvement.prompt.yml. While the existing file focuses on improving the naturalness of English documentation translated from Chinese, this new prompt file focuses on improving the authenticity and accuracy of code examples throughout the documentation.

Purpose

The new prompt configuration provides AI-assisted guidelines for ensuring that:

  • Code examples are accurate, runnable, and follow best practices
  • Configuration examples are complete and valid
  • Variable names and values are realistic (not just placeholder text)
  • Import statements and dependencies match what's actually available
  • File paths, package names, and API references are correct

Key Features

The prompt instructs contributors to:

  • Verify that code examples actually work before committing changes
  • Use realistic identifiers instead of generic placeholders like foo and bar (unless demonstrating a concept)
  • Update both English (docs/en) and Chinese (docs/zh) versions when making technical changes
  • Add error handling or edge cases where appropriate
  • Keep examples simple but complete enough to be useful

Consistency

The file follows the same structure and conventions as docs-en-improvement.prompt.yml:

  • Uses YAML format with the same schema
  • References the same model (openai/gpt-5)
  • Maintains similar constraints (max 10 files per PR, docs: prefix for PR titles)
  • Scopes work to the website/docs directory

This addition enables more focused improvements to the Rsbuild documentation by separating concerns between language quality and technical accuracy.

Original prompt

@improve_doc_authenticity.md


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Oct 6, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 859c0b3
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68e3d04ea9c9ac0008f68149
😎 Deploy Preview https://deploy-preview-6313--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 64 (🔴 down 3 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@Copilot Copilot AI changed the title [WIP] @improve_doc_authenticity.md docs: create improve-doc-authenticity.prompt.yml for code example quality Oct 6, 2025
@chenjiahan chenjiahan closed this Oct 7, 2025
@chenjiahan chenjiahan deleted the copilot/fix-7b71cf3c-3db2-4b53-89b9-796066c1e9ea branch October 7, 2025 04:02
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.

3 participants