feat(docs): add expandable summaries to collections table#1269
Closed
monssefbaakka wants to merge 3 commits into
Closed
feat(docs): add expandable summaries to collections table#1269monssefbaakka wants to merge 3 commits into
monssefbaakka wants to merge 3 commits into
Conversation
Member
|
@monssefbaakka - can you sign the CLA so we can move forward with the contribution? |
Member
|
Converting this to draft because the CLA needs to be signed |
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR enhances the Docusaurus Collections overview page (
docs/getting-started/collections.md) by displaying the richer, detailed descriptions from each*.collection.mdfile without requiring users to navigate away from the table.Changes Made
CollectionsTable): Replaced the static markdown table with a Docusaurus-native React component that renders the collection metrics along with a<details>expandable row.scripts/extract-collection-summaries.js) to parse the first paragraph/frontmatter description from allcollections/*.collection.mdfiles.collectionData.jsonartifact 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
npm installandnpm run startin thedocs/docusaurus/directory.node scripts/extract-collection-summaries.jssuccessfully repopulates the JSON store if any changes are made to the markdown files.