Skip to content

docs: update config overview UI#435

Merged
9aoy merged 3 commits intomainfrom
docs/config-overview
Aug 1, 2025
Merged

docs: update config overview UI#435
9aoy merged 3 commits intomainfrom
docs/config-overview

Conversation

@9aoy
Copy link
Copy Markdown
Collaborator

@9aoy 9aoy commented Aug 1, 2025

Summary

before:
image

after:
image

Related Links

Checklist

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

Copilot AI review requested due to automatic review settings August 1, 2025 09:16
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 updates the configuration overview UI by restructuring the component architecture and content organization. The changes move from a generic overview system to specialized configuration overview components with improved categorization.

  • Replaced the generic Overview component with specialized ConfigOverview components
  • Reorganized configuration items into logical groups (basic, runtime, environment, mock, output)
  • Updated styling to improve visual presentation and spacing

Reviewed Changes

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

Show a summary per file
File Description
website/theme/components/Overview.tsx Removed generic overview component that used external data
website/theme/components/ConfigOverview.tsx Added new specialized component with hardcoded config groups and build overview
website/theme/components/ConfigOverview.module.scss Updated styles with reduced margins and improved link targeting
website/docs/zh/config/test/_meta.json Reorganized test configuration order to match new grouping structure
website/docs/zh/config/index.mdx Updated to use new ConfigOverview components with separate test and build sections
website/docs/en/config/test/_meta.json Reorganized test configuration order to match new grouping structure
website/docs/en/config/index.mdx Updated to use new ConfigOverview components with separate test and build sections
Comments suppressed due to low confidence (1)

website/theme/components/ConfigOverview.tsx:60

  • The function name 'Overview' is inconsistent with the file name 'ConfigOverview'. Consider renaming to 'ConfigOverview' for clarity.
export default function Overview() {

<div key={group.name} className={styles.overviewGroups}>
<div className={styles.group}>
<h2>
<Link href={`/config/build/${group.name}`}> {group.name}</Link>
Copy link

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's an extra space before the closing angle bracket in the Link component. Remove the space for consistency.

Copilot uses AI. Check for mistakes.

const BUILD_OVERVIEW_GROUPS: Group[] = [
{
name: 'plugins',
Copy link

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'plugins' group has no items defined, which may result in an empty section being rendered. Consider adding items or handling empty groups gracefully.

Copilot uses AI. Check for mistakes.
@netlify
Copy link
Copy Markdown

netlify bot commented Aug 1, 2025

Deploy Preview for rstest-dev ready!

Name Link
🔨 Latest commit 4bac427
🔍 Latest deploy log https://app.netlify.com/projects/rstest-dev/deploys/688c867f98a3e500080daa3e
😎 Deploy Preview https://deploy-preview-435--rstest-dev.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.

@9aoy 9aoy merged commit f67355f into main Aug 1, 2025
16 checks passed
@9aoy 9aoy deleted the docs/config-overview branch August 1, 2025 09:42
@9aoy 9aoy mentioned this pull request Aug 5, 2025
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.

2 participants