Skip to content

docs: mention rspress-description-generator agent skill in custom-head docs#3232

Merged
SoonIter merged 1 commit intomainfrom
syt-vibe-kanban/f5ba-custom-headers-d
Mar 16, 2026
Merged

docs: mention rspress-description-generator agent skill in custom-head docs#3232
SoonIter merged 1 commit intomainfrom
syt-vibe-kanban/f5ba-custom-headers-d

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Mar 16, 2026

Summary

Related Issue

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Added a tip in the "How description is determined" section of the custom-head docs (both English and Chinese) to mention the rspress-description-generator agent skill, which can automatically generate description frontmatter for all pages.

This helps users discover the agent skill as a convenient alternative to manually writing descriptions for every page, complementing the existing documentation on how descriptions are extracted and overridden.

This PR was written using Vibe Kanban


Copilot AI review requested due to automatic review settings March 16, 2026 06:43
@SoonIter SoonIter changed the title 在 custom-headers 的 description 中,提一下 (vibe-kanban) docs: mention rspress-description-generator agent skill in custom-head docs Mar 16, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 12.4 MB +946.0 B (0.0%)
node_md 1.6 MB +1.0 KB (0.1%)
web 16.1 MB +902.0 B (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

Path: website/doc_build/diff-rsdoctor/node/rsdoctor-data.json

📌 Baseline Commit: 8d620050cc | PR: #3230

Metric Current Baseline Change
📊 Total Size 12.4 MB 12.4 MB +946.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 12.4 MB 12.4 MB +946.0 B (0.0%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: node Bundle Diff

📁 node_md

Path: website/doc_build/diff-rsdoctor/node_md/rsdoctor-data.json

📌 Baseline Commit: 8d620050cc | PR: #3230

Metric Current Baseline Change
📊 Total Size 1.6 MB 1.6 MB +1.0 KB (0.1%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.6 MB 1.6 MB +1.0 KB (0.1%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

Path: website/doc_build/diff-rsdoctor/web/rsdoctor-data.json

📌 Baseline Commit: 8d620050cc | PR: #3230

Metric Current Baseline Change
📊 Total Size 16.1 MB 16.1 MB +902.0 B (0.0%)
📄 JavaScript 15.9 MB 15.9 MB +902.0 B (0.0%)
🎨 CSS 120.3 KB 120.3 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 166.2 KB 166.2 KB 0

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

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

Adds a documentation tip to the “custom head” advanced guide to point readers to the rspress-description-generator Agent Skill for automatically generating page description metadata.

Changes:

  • Added a :::tip callout in the Chinese doc linking to rspress-description-generator and the Agent Skills section.
  • Added the same :::tip callout in the English doc for parity.

Reviewed changes

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

File Description
website/docs/zh/guide/advanced/custom-head.mdx Adds a tip linking to the description generator Agent Skill and the Agent Skills docs.
website/docs/en/guide/advanced/custom-head.mdx Adds the equivalent tip in English for consistent guidance.

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

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying rspress-v2 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 405243b
Status: ✅  Deploy successful!
Preview URL: https://39c3e78c.rspress-v2.pages.dev
Branch Preview URL: https://syt-vibe-kanban-f5ba-custom.rspress-v2.pages.dev

View logs

@SoonIter SoonIter merged commit 0ea1fdd into main Mar 16, 2026
11 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/f5ba-custom-headers-d branch March 16, 2026 07:22
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