Skip to content

feat(docs): add expandable summaries to collections table#1269

Closed
monssefbaakka wants to merge 3 commits into
microsoft:mainfrom
monssefbaakka:main
Closed

feat(docs): add expandable summaries to collections table#1269
monssefbaakka wants to merge 3 commits into
microsoft:mainfrom
monssefbaakka:main

Conversation

@monssefbaakka
Copy link
Copy Markdown

This PR enhances the Docusaurus Collections overview page (docs/getting-started/collections.md) by displaying the richer, detailed descriptions from each *.collection.md file without requiring users to navigate away from the table.

Changes Made

  • New React Component (CollectionsTable): Replaced the static markdown table with a Docusaurus-native React component that renders the collection metrics along with a <details> expandable row.
  • Data Extraction Script: Added a Node.js utility (scripts/extract-collection-summaries.js) to parse the first paragraph/frontmatter description from all collections/*.collection.md files.
  • Shared Data Store: Generated an initial collectionData.json artifact using the extraction script to serve the expanded rows. This keeps the overview table perfectly in sync with the source truth of each collection doc.

How to Test

  1. Run npm install and npm run start in the docs/docusaurus/ directory.
  2. Navigate to the Topics > Get Started > Collections Overview page.
  3. Verify that the layout remains consistent but now features an expandable "View details" row beneath each table entry containing the full summary.
  4. Check that running node scripts/extract-collection-summaries.js successfully repopulates the JSON store if any changes are made to the markdown files.

@monssefbaakka monssefbaakka requested a review from a team as a code owner April 1, 2026 21:31
@WilliamBerryiii
Copy link
Copy Markdown
Member

@monssefbaakka - can you sign the CLA so we can move forward with the contribution?

@WilliamBerryiii WilliamBerryiii marked this pull request as draft April 23, 2026 19:20
@WilliamBerryiii
Copy link
Copy Markdown
Member

Converting this to draft because the CLA needs to be signed

@WilliamBerryiii
Copy link
Copy Markdown
Member

Closing this out but will leave the issue open. The CLA needs to be signed or a core maintainer needs to pick up the workflow.

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