Skip to content

docs: add tip for pageType: doc-wide usage with outline: false#3005

Merged
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/2dee-
Jan 14, 2026
Merged

docs: add tip for pageType: doc-wide usage with outline: false#3005
SoonIter merged 3 commits intomainfrom
syt-vibe-kanban/2dee-

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Jan 14, 2026 •
edited
Loading

Summary

Related Issue

Checklist

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

AI Summary

Changes Made

Added documentation explaining the difference between outline: false and pageType: doc-wide in the frontmatter configuration docs.

Modified files:

  • website/docs/zh/api/config/config-frontmatter.mdx
  • website/docs/en/api/config/config-frontmatter.mdx

Details

When users set outline: false, the outline column is hidden but the space it occupied is still reserved. This can be confusing for users who expect the main content to expand into that space.

The new tip explains that to make the main content occupy a wider screen space, users should use pageType: doc-wide together with outline: false and sidebar: false:

---
pageType: doc-wide
outline: false
sidebar: false
---

This combination allows the main content area to automatically expand and occupy the space originally used by the sidebar and outline column.

This PR was written using Vibe Kanban

@SoonIter
已完成文档更新。我在中英文的 frontmatter 配置文档的 outline 部分添加了说明，解释了：
c9c53e8 
1. **`outline: false`** - 仅隐藏大纲栏，但空间保留
2. **`pageType: doc-wide`** - 配合 `outline: false` 和 `sidebar: false` 使用时，正文内容会自动占据更宽的屏幕空间

修改的文件：
- `website/docs/zh/api/config/config-frontmatter.mdx:244-256`
- `website/docs/en/api/config/config-frontmatter.mdx:244-256`
Copilot AI review requested due to automatic review settings January 14, 2026 10:05
@netlify
Copy link
Copy Markdown

netlify bot commented Jan 14, 2026 •
edited
Loading

✅ Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit 231acbc
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/69676dc7f401e80008da32ee
😎 Deploy Preview https://deploy-preview-3005--rspress-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@SoonIter SoonIter changed the title 增加文档 (vibe-kanban) docs: add tip for pageType: doc-wide usage with outline: false Jan 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 14, 2026 •
edited
Loading

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 10.4 MB +11.2 KB (0.1%)
node_md 1.3 MB +3.1 KB (0.2%)
web 15.8 MB +8.1 KB (0.1%)
📋 Detailed Reports (Click to expand)

📁 node

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

📌 Baseline Commit: 4a5b6e3360 | PR: #3001

Metric Current Baseline Change
📊 Total Size 10.4 MB 10.4 MB +11.2 KB (0.1%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 10.4 MB 10.4 MB +11.2 KB (0.1%)
📁 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: 4a5b6e3360 | PR: #3001

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

📦 Download Diff Report: node_md Bundle Diff

📁 web

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

📌 Baseline Commit: 4a5b6e3360 | PR: #3001

Metric Current Baseline Change
📊 Total Size 15.8 MB 15.8 MB +8.1 KB (0.1%)
📄 JavaScript 15.0 MB 15.0 MB +6.6 KB (0.0%)
🎨 CSS 126.3 KB 126.3 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 672.9 KB 671.4 KB +1.6 KB (0.2%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

Copilot AI reviewed Jan 14, 2026
View reviewed changes
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

This PR adds documentation explaining the usage of pageType: doc-wide in the frontmatter configuration documentation, specifically clarifying how it differs from using just outline: false.

Changes:

  • Added tip sections to both Chinese and English frontmatter documentation files explaining that outline: false only hides the outline column while preserving its space
  • Provided examples of using pageType: doc-wide with outline: false and sidebar: false to make content occupy wider screen space

Reviewed changes

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

File Description
website/docs/zh/api/config/config-frontmatter.mdx Added Chinese documentation tip explaining pageType: doc-wide usage with outline: false and sidebar: false
website/docs/en/api/config/config-frontmatter.mdx Added English documentation tip explaining pageType: doc-wide usage with outline: false and sidebar: false

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

@SoonIter
已根据 review 意见修改：
c55c647 
1. 移除了 `sidebar: false`，简化示例为只包含 `pageType: doc-wide` 和 `outline: false`
2. 添加了 `pageType` 的页内链接 `[pageType: doc-wide](#pagetype)`
3. 中英文文档都已更新
@SoonIter
已在 sidebar 部分添加相同的提示，中英文文档都已更新：
231acbc 
- **英文**: 说明 `sidebar: false` 仅隐藏侧边栏但空间保留，可配合 `pageType: doc-wide` 使用
- **中文**: 同样的说明
@SoonIter SoonIter requested a review from Timeless0911 January 14, 2026 11:01
@SoonIter SoonIter enabled auto-merge (squash) January 14, 2026 11:01
@SoonIter SoonIter merged commit 8b7c055 into main Jan 14, 2026
8 checks passed
@SoonIter SoonIter deleted the syt-vibe-kanban/2dee- branch January 14, 2026 12:08
This was referenced Jan 14, 2026
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Timeless0911 Timeless0911 Timeless0911 approved these changes

Assignees

No one assigned

Labels

change: docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SoonIter @Timeless0911