-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
feat(addon-docs): add MDX manifest generation #33408
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
Draft
Copilot
wants to merge
8
commits into
next
Choose a base branch
from
copilot/add-mdx-support-manifest
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
+505
−1
Conversation
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
- Create manifest.ts to generate manifests for MDX files - Filter MDX entries with 'attached-mdx' or 'unattached-mdx' tags - Export experimental_manifests from preset.ts - Add comprehensive tests for MDX manifest generation Co-authored-by: JReinhold <5678122+JReinhold@users.noreply.github.com>
Co-authored-by: JReinhold <5678122+JReinhold@users.noreply.github.com>
Co-authored-by: JReinhold <5678122+JReinhold@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add support for MDX files in manifest generation
feat(addon-docs): add MDX manifest generation
Dec 22, 2025
Base automatically changed from
jeppe/support-manifest-tag-in-preview
to
next
December 22, 2025 22:04
Contributor
|
|
View your CI Pipeline Execution ↗ for commit b011a73
☁️ Nx Cloud last updated this comment at |
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.
Extends the manifest generation system to include MDX documentation files alongside component manifests.
Implementation
code/addons/docs/src/manifest.ts: Newexperimental_manifestspreset function that filters MDX entries tagged withmanifest+ (attached-mdx|unattached-mdx) and generates structured manifest entriescode/addons/docs/src/preset.ts: Exports the new manifest functioncode/addons/docs/src/manifest.test.ts: Test coverage for MDX entry filtering, manifest structure, and edge casesManifest Structure
MDX manifests are accessible at
/manifests/mdx.json:Example output:
{ "v": 0, "entries": { "example--docs": { "id": "example--docs", "name": "docs", "path": "./Example.mdx", "title": "Example", "tags": ["manifest", "attached-mdx"], "storiesImports": ["./Example.stories.tsx"] } } }The implementation preserves existing manifests (e.g.,
components) and follows the established preset pattern.Original prompt
Start implementation
The user has attached the following file paths as relevant context:
- .github/copilot-instructions.md
[Chronological Review: The conversation began with the user requesting enhancements to the manifest generation for the React renderer in Storybook. The user specified that addon-docs should include MDX files in the generated manifests, with specific tagging and structure requirements. The user then clarified that instead of modifying the existing generator.ts, a new manifest.ts should be created in addon-docs to extend the existing manifests. The user further refined the content structure for the MDX files to include meta properties similar to the existing component manifest. Finally, the user requested to start the implementation.][Intent Mapping:
[Technical Inventory:
[Code Archaeology:
[Progress Assessment:
[Context Validation: All necessary details for continuing the implementation of the new manifest generation are captured, including structure and tagging requirements.]
[Recent Commands Analysis:
1. Conversation Overview: - Primary Objectives: - "We need to enhance our manifest generation..." - Include MDX files in the component manifests. - "no, do not extend generator.ts..." - Create a new manifest.ts file in addon-docs. - "my original content proposal was too simplistic..." - Refine the structure of MDX entries to include meta properties. - "Start implementation" - Begin coding the solution. - Session Context: The conversation flowed from outlining requirements to refining the structure and finally requesting implementation. - User Intent Evolution: The user initially proposed a simple mapping for MDX files but later refined it to include more complex meta properties.- Technical Foundation:
- Storybook: A framework for building UI components in isolation.
- React: The library used for building user interfaces.
- Manifest Generation: The process of creating a structured representation of components and their associated documentation.
- Codebase Status:
- File Name: StoryIndexGenerator.test.ts
- Purpose: Testing the story index generation functionality.
- Current State: User is preparing to implement a new manifest generation logic.
- Key Code Segments: Not specified yet as implementation has not started.
- Dependencies: Will relate to the existing component manifest structure.
- Problem Resolution:
- Issues Encountered: Initial proposal for MDX structure was too simplistic.
- Solutions Implemented: User refined the structure to include meta properties.
- Debugging Context: No ongoing issues reported; focus is on new implementation.
- Lessons Learned: Importance of detailed structure in manifest generation.
- Progress Tracking:
- Completed Tasks: User has outlined the requirements for the new manifest generation.
- Partially Complete Work: Implementation of the new manifest.ts file is pending.
- Validated Outcomes: No features confirmed working yet as implementation has not started.
- Active Work State:
- Current Focus: Preparing to implement the new manifest generation logic in addon-docs.
- Recent Context: User has clarified requirements and is ready to start coding.
- Working Code: No specific code snippets discussed recently.
- Immediate Context: User requested to "Start implementat...
Created from VS Code.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.