Skip to content

Tags: Fix MDX tags handling in index#26633

Closed
shilman wants to merge 3 commits into
nextfrom
shilman/fix-mdx-tags
Closed

Tags: Fix MDX tags handling in index#26633
shilman wants to merge 3 commits into
nextfrom
shilman/fix-mdx-tags

Conversation

@shilman
Copy link
Copy Markdown
Member

@shilman shilman commented Mar 24, 2024

Closes N/A

Based on storybookjs/docs-mdx#17

What I did

Handle <Meta tags={['a', 'b']} /> in unattached docs pages

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@shilman shilman added bug mdx tags ci:normal Run our default set of CI jobs (choose this for most PRs). labels Mar 24, 2024
@shilman shilman changed the title Index: Fix MDX tags handling Tags: Fix MDX tags handling in index Mar 24, 2024
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Mar 24, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 80c5279. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


🟥 Failed Commands
nx run-many -t build -c production --parallel=3

Sent with 💌 from NxCloud.

Copy link
Copy Markdown
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, but is there a docs-mdx PR I should be looking at ?

Comment on lines +428 to +429
// FIXME: update this to use the index entry's metaTags once we update this to run on `IndexInputs`
tags: [...(result.tags || []), csfEntry ? 'attached-mdx' : 'unattached-mdx', 'docs'],
tags: [...(result.metaTags || []), csfEntry ? 'attached-mdx' : 'unattached-mdx', 'docs'],
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the FIXME here mean?

@shilman
Copy link
Copy Markdown
Member Author

shilman commented Nov 19, 2024

Replaced by #29655

@shilman shilman closed this Nov 19, 2024
@kasperpeulen kasperpeulen deleted the shilman/fix-mdx-tags branch April 4, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug ci:normal Run our default set of CI jobs (choose this for most PRs). mdx tags

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants