Skip to content
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

Docs: Use stories-mdx and autodocs tags instead of standalone: false in index #20424

Merged
merged 6 commits into from
Dec 30, 2022

Conversation

tmeasday
Copy link
Member

Issue: N/A

Telescoping on #20417

What I did

  • Dropped standalone field from docs index entries
  • Ensure all "templated" entries get either stories-mdx or autodocs tag
  • Use tags to drive behaviour instead of standalone.

How to test

Check all MDX files render OK.

@tmeasday tmeasday added maintenance User-facing maintenance tasks addon: docs labels Dec 28, 2022
@tmeasday tmeasday requested a review from shilman December 28, 2022 02:43
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

@tmeasday this change looks like a huge step forward. loving it!

What's the best way to merge it though? Merge the mdx2-csf PR, update this PR, and pray that it goes green? I'm worried about the possibility that it doesn't go green & we are in an inconsistent state with the mdx2-csf library. Any thoughts?

@tmeasday
Copy link
Member Author

Is it possible to do a canary release of the mdx2-csf library?

@shilman
Copy link
Member

shilman commented Dec 29, 2022

@tmeasday it happens automatically. not sure why it's not commenting on the PR, but you can see it browsing to the GH actions. the canary version is 0.0.4-canary.ab2d92c.0 -- updating now

Base automatically changed from replace-mdx-tag-with-stories-mdx to next December 30, 2022 10:44
@shilman shilman merged commit 72dac4e into next Dec 30, 2022
@shilman shilman deleted the replace-standalone-with-autodocs branch December 30, 2022 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants