-
Notifications
You must be signed in to change notification settings - Fork 95
Split authoring docs into component-specific pages #502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
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>
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
|
@copilot remove " Component" from authoring pages title set |
Co-authored-by: abernier <76580+abernier@users.noreply.github.com>
|
@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 |
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.) |
abernier
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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
- retire
## Bakers: on a déjà letitle:c'est redondant! - a la place de 1., insere une
<Intro>TEXT</Intro>, avec unTEXTqui n'est pas redondant dedescription:mais qui donne une bonne overview du composant décrit par la page - remplace
### Resultparresult:
There was a problem hiding this comment.
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:
- Removed redundant component name headers (e.g.,
## Backers) - Added
<Intro>components with comprehensive overviews that expand on the descriptions - Replaced
### Resultheadings withresult:markers
docs/authoring/img.mdx
Outdated
| @@ -0,0 +1,55 @@ | |||
| --- | |||
| title: Images | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
…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>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. |
…:pmndrs/docs into copilot/rename-authoring-files-and-tests
Comment out sandpack and codesandbox routes in tests.
Restructures the monolithic
getting-started/authoring.mdxinto discrete pages underauthoring/, one per component.Changes
getting-started/authoring.mdx→authoring/introduction.mdx<Intro>component with detailed overviews that expand beyond the simple frontmatter description## Backers) that duplicated the page titleImgnotImages)### Resultheadings toresult:markers for cleaner formattingauthoring-sandpack-cloud/andgutenberg.jpgtoauthoring/directorypage.test.ts(light/dark variants for each page)Example
Before:
/getting-started/authoringwith all components documented in one fileAfter:
/authoring/introduction- Overview and frontmatter/authoring/intro- Intro component with detailed explanation/authoring/sandpack- Sandpack component with comprehensive guideOriginal prompt
💡 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.