Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Restructures the monolithic getting-started/authoring.mdx into discrete pages under authoring/, one per component.

Changes

  • Renamed: getting-started/authoring.mdxauthoring/introduction.mdx
  • Split into component pages: Intro, Keypoints, Img, Code, Mermaid, Grid, Sandpack, Codesandbox, Gha, Hint, Contributors, Backers (12 new pages)
  • Added Intro components: Each page includes a comprehensive <Intro> component with detailed overviews that expand beyond the simple frontmatter description
  • Removed redundant headers: Removed component name headers (e.g., ## Backers) that duplicated the page title
  • Fixed titles: Component names match exactly (e.g., Img not Images)
  • Replaced Result sections: Changed ### Result headings to result: markers for cleaner formatting
  • Moved assets: authoring-sandpack-cloud/ and gutenberg.jpg to authoring/ directory
  • Refactored tests: Replaced 250+ lines of repetitive test code with a ~40-line loop structure
  • Added tests: 26 test cases in page.test.ts (light/dark variants for each page)

Example

Before: /getting-started/authoring with all components documented in one file

After:

  • /authoring/introduction - Overview and frontmatter
  • /authoring/intro - Intro component with detailed explanation
  • /authoring/sandpack - Sandpack component with comprehensive guide
  • ...etc
Original prompt

dans la page renomme getting-started/authoring.mdx en authoring/introduction.mdx puis fais de chaque composant : Intro, Keypoints, Img... etc une page dediee, eg: authoring/intro.mdx, ... etc. Remplace <details> par ## Result Enfin, test() chacune dans app/[...slug]/page.test.ts


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Copilot AI and others added 2 commits January 27, 2026 12:40
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Copilot AI changed the title [WIP] Rename getting-started/authoring.mdx to authoring/introduction.mdx and split components Split authoring docs into component-specific pages Jan 27, 2026
Copilot AI requested a review from abernier January 27, 2026 12:44
@abernier
Copy link
Member

@copilot remove " Component" from authoring pages title

set ## Result a h3 instead

Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 27, 2026

@copilot remove " Component" from authoring pages title

set ## Result a h3 instead

Done in 171c76b:

  • Removed " Component" suffix from all authoring page titles
  • Changed all ## Result headers to ### Result (h3 instead of h2)

@abernier
Copy link
Member

@copilot for each new pages, try inserting a good that is not redundant with description nor the pagés content but give a quick overview of the purpose of the mdx component + give each new page a title vale of the exact name of the component, eg: Img not Images

Copy link
Contributor Author

Copilot AI commented Jan 27, 2026

@copilot for each new pages, try inserting a good that is not redundant with description nor the pagés content but give a quick overview of the purpose of the mdx component + give each new pa...

The comment appears to be incomplete. Could you clarify what you'd like me to insert for each new page? (e.g., a good example, a good description, etc.)

Copy link
Member

@abernier abernier left a comment

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

@copilot applique cela a toutes les autres pages docs/authoring/*.mdx

  1. retire ## Bakers: on a déjà le title: c'est redondant!
  2. a la place de 1., insere une <Intro>TEXT</Intro>, avec un TEXT qui n'est pas redondant de description: mais qui donne une bonne overview du composant décrit par la page
  3. remplace ### Result par result:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 74c98ef. Applied to all authoring pages:

  1. Removed redundant component name headers (e.g., ## Backers)
  2. Added <Intro> components with comprehensive overviews that expand on the descriptions
  3. Replaced ### Result headings with result: markers

@@ -0,0 +1,55 @@
---
title: Images
Copy link
Member

Choose a reason for hiding this comment

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

@copilot ceci est aussi valable pour d'autres pages: pour title: reprend toujours le nom du composant, ici Img (pas Images) - tel quel

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 74c98ef. Changed title: Images to title: Img to match the component name exactly.

Copy link
Member

Choose a reason for hiding this comment

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

@copilot fais une boucle plutot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 74c98ef. Refactored tests to use a loop, reducing ~250 lines to ~40 lines. The loop iterates over a pages array and generates light/dark mode tests for each page.

Copilot AI and others added 3 commits January 27, 2026 13:24
…sts to use loop

Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 27, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Copilot AI requested a review from abernier January 27, 2026 13:27
…:pmndrs/docs into copilot/rename-authoring-files-and-tests
Comment out sandpack and codesandbox routes in tests.
@abernier abernier marked this pull request as ready for review January 27, 2026 15:43
@abernier abernier merged commit 9f41a7e into main Jan 27, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants