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

Docs2: Handle new docs entries in the preview #18099

Merged
merged 16 commits into from
May 9, 2022

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Apr 29, 2022

Telescoping on #18023

  • Ensure we set moduleExport when processing/preparing a story
  • Refactor PreviewWeb to read new entry types from the index to decide on docs only behaviour
  • Add loadDocsEntry function that pre-loads storyImports
  • Move DocsRenderer to addon-docs and rationalize import behaviour
  • Add of={} behaviour to Story element

@nx-cloud
Copy link

nx-cloud bot commented Apr 29, 2022

☁️ Nx Cloud Report

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

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@tmeasday tmeasday force-pushed the future/docs2/preview branch from ad2c719 to ce7a34e Compare May 2, 2022 06:17
@tmeasday tmeasday marked this pull request as draft May 2, 2022 06:18
lib/store/src/StoryStore.ts Outdated Show resolved Hide resolved
lib/preview-web/src/DocsRender.ts Outdated Show resolved Hide resolved
lib/preview-web/src/DocsRender.ts Outdated Show resolved Hide resolved
@tmeasday tmeasday force-pushed the future/docs2/preview branch 2 times, most recently from 8ee1e28 to 39f93de Compare May 6, 2022 01:59
@tmeasday tmeasday marked this pull request as ready for review May 6, 2022 03:08
@tmeasday tmeasday force-pushed the future/docs2/preview branch from 39f93de to e4b9bd7 Compare May 6, 2022 03:11
@tmeasday tmeasday added feature request maintenance User-facing maintenance tasks core and removed feature request labels May 6, 2022
@tmeasday tmeasday requested a review from shilman May 6, 2022 05:00
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 Not sure how to best review this one. I agree with the changes in principle per our discussions.

There's still one unit test failure to take care of! 🙏

lib/preview-web/src/types.ts Show resolved Hide resolved
@tmeasday
Copy link
Member Author

tmeasday commented May 9, 2022

I would look closely at the changes to:

  • StoryStore
  • PreviewWeb
  • DocsRender and
  • useStory.

@tmeasday tmeasday force-pushed the future/docs2/preview branch from 87f2203 to 443ecdf Compare May 9, 2022 00:27
lib/store/src/types.ts Outdated Show resolved Hide resolved
lib/preview-web/src/PreviewWeb.tsx Outdated Show resolved Hide resolved
Base automatically changed from future/docs2/manager-ui to future-hybrid-stories-index May 9, 2022 15:35
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.

100% awesome! So many improvements in here

@shilman shilman changed the title Handle new docs entries in the preview Docs2: Handle new docs entries in the preview May 9, 2022
@shilman shilman merged commit 4c47903 into future-hybrid-stories-index May 9, 2022
@shilman shilman deleted the future/docs2/preview branch May 9, 2022 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs core maintenance User-facing maintenance tasks mdx
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants