docs: create improve-doc-authenticity.prompt.yml for code example quality #6313
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new prompt configuration file
improve-doc-authenticity.prompt.yml
to complement the existingdocs-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:
Key Features
The prompt instructs contributors to:
foo
andbar
(unless demonstrating a concept)docs/en
) and Chinese (docs/zh
) versions when making technical changesConsistency
The file follows the same structure and conventions as
docs-en-improvement.prompt.yml
:openai/gpt-5
)docs:
prefix for PR titles)website/docs
directoryThis addition enables more focused improvements to the Rsbuild documentation by separating concerns between language quality and technical accuracy.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.