Skip to content

Add documentation for Entries component and change default behavior#504

Merged
abernier merged 9 commits intomainfrom
copilot/create-entries-page-mdx
Jan 30, 2026
Merged

Add documentation for Entries component and change default behavior#504
abernier merged 9 commits intomainfrom
copilot/create-entries-page-mdx

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Create documentation page for Entries MDX component ✅

Based on the problem statement and exploration of the repository, I created a documentation page for the Entries MDX component following the existing patterns in docs/authoring/*.mdx and changed the component's default behavior.

Completed Tasks:

  • Explore the repository structure and understand existing authoring pages
  • Understand the Entries component implementation and usage
  • Understand the frontmatter pattern and navigation order
  • Create docs/authoring/entries.mdx with proper frontmatter and documentation
  • Run linting to ensure code quality
  • Validate with CI simulation (act)
  • Get code review feedback
  • Address code review feedback (CodeSandbox capitalization)
  • Final code review - no issues found
  • Security scan - no vulnerabilities
  • Add second CodeSandbox example (id: 5w35n6) as requested by @abernier
  • Clarify CodeSandbox integration section to explain how it relates to Entries
  • Change component behavior to show all categories by default

Summary:

Component Changes:

  • Modified src/components/mdx/Entries/Entries.tsx to change default excludedGroups from ['getting-started'] to []
  • Now all categories are shown by default, including getting-started

Documentation:
Created a comprehensive documentation page at docs/authoring/entries.mdx that documents:

  • Basic usage of the Entries component with examples
  • CodeSandbox integration section explaining how pages with CodeSandbox examples appear in the Entries listing with icons (includes example with id 5w35n6)
  • How to exclude specific categories using the excludedGroups prop
  • Internal behavior and features of the component
  • Responsive layout information (2 columns mobile, 3 columns desktop)

The page follows the exact same structure as other authoring documentation pages, with proper frontmatter metadata, navigation order (14), and sourcecode reference.

Original prompt

sur les modeles de pages authoring/*.md creer une page pour Entries (le composant mdx)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 27, 2026 18:13
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] Add entries page for MDX component Add documentation for Entries component Jan 27, 2026
Copilot AI requested a review from abernier January 27, 2026 18:19
@abernier
Copy link
Member

@copilot ok ca marche bien.

2 details:

  • pkoi la "categorie" getting-started n'apparait pas (ignoree par defaut)?
  • change l'id de la 2e codesandbox par 5w35n6 histoire qu'on ait pas 2x la meme

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

Copilot AI commented Jan 27, 2026

@copilot ok ca marche bien.

2 details:
...

Done in commit 4843b85:

  1. Added explanation: getting-started category is excluded by default to keep the directory focused on reference documentation
  2. Added second CodeSandbox example with id 5w35n6

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

  1. Added explanation: getting-started category is excluded by default to keep the directory focused on reference documentation

do not, change this @copilot

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

Copilot AI commented Jan 27, 2026

  1. Added explanation: getting-started category is excluded by default to keep the directory focused on reference documentation

do not, change this @copilot

Reverted in commit 39e34d5. Changed back to the simpler text: "The default excluded groups are ['getting-started']."

  1. Added explanation: getting-started category is excluded by default to keep the directory focused on reference documentation

do not, change this @copilot

Changed the behavior in commit 4cd7d49. The Entries component now shows all categories by default (changed excludedGroups = [] instead of ['getting-started']). The getting-started category will now appear in the listing.

Copilot AI and others added 2 commits January 27, 2026 18:42
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 Add documentation for Entries component Add documentation for Entries component and change default behavior Jan 27, 2026
@abernier abernier marked this pull request as ready for review January 30, 2026 10:35
@abernier abernier merged commit c102a35 into main Jan 30, 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

Comments