docs(website): generate description for all documentations#1537
Merged
Timeless0911 merged 2 commits intomainfrom Mar 17, 2026
Merged
docs(website): generate description for all documentations#1537Timeless0911 merged 2 commits intomainfrom
Timeless0911 merged 2 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds description frontmatter to all standalone MDX pages in both the English and Chinese Rslib documentation. Each page now carries a concise meta description suitable for SEO and social previews, with EN/ZH pairs conveying the same meaning.
Changes:
- Added
descriptionfrontmatter to ~90 MDX files acrosswebsite/docs/en/andwebsite/docs/zh/. - Files without existing frontmatter received new
---delimited blocks; files with existing frontmatter had the description field inserted alongside other fields.
Reviewed changes
Copilot reviewed 126 out of 126 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
website/docs/en/**/*.mdx |
Added English description frontmatter to all EN doc pages |
website/docs/zh/**/*.mdx |
Added Chinese description frontmatter to all ZH doc pages |
Deploying rslib with
|
| Latest commit: |
75f3279
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3a24cda5.rslib.pages.dev |
| Branch Preview URL: | https://david-docs-website-descripti.rslib.pages.dev |
fi3ework
approved these changes
Mar 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Generate description for all documentations via rstackjs/agent-skills#rspress-description-generator
This can improve the qualify of
llms.txt.Related Links
Checklist