-
Notifications
You must be signed in to change notification settings - Fork 10
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
[wb1733.1.adddocsfixdocslinks] Add docs for new WB Testing and fix links #2276
Conversation
|
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
npm Snapshot: NOT Published🤕 Oh noes!! We couldn't find any changesets in this PR (48be0b6). As a result, we did not publish an npm snapshot for you. |
A new build was pushed to Chromatic! 🚀https://5e1bf4b385e3fb0020b7073c-lxacpwdvub.chromatic.com/ Chromatic results:
|
Size Change: 0 B Total Size: 94 kB ℹ️ View Unchanged
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2276 +/- ##
==========================================
+ Coverage 94.30% 95.21% +0.91%
==========================================
Files 251 251
Lines 29666 29666
Branches 1686 2442 +756
==========================================
+ Hits 27976 28246 +270
+ Misses 1685 1402 -283
- Partials 5 18 +13 see 38 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: New section for WBT exports that aren't part of the existing fixtures, mocking, or test harness frameworks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks and works great! thanks for fixing all the broken links 👏 🚢
Summary:
This adds docs for the new
boundary
adapter and the newrenderHookStatic
call to the Wonder Blocks Testing package. It also updates the overview to explain some things about Wonder Blocks Testing Core.In addition, I discovered that most of the intra-story links in MDX files were not working. After some investigation and discussion with @jandrade, it was determined that the markdown link format just doesn't currently work properly and that converting to
<a>
links with slightly changed href works as needed.I used some regexp to convert from the markdown version to the markup version.
1. Markdown to markup
Find:
\[((?:[^\[\]])+)\]\((/docs/[^\)]+)\)
Replace:
<a href="./?path=$2">$1</a>
2. Add the missing leading
packages-
to the linksSeems that we reorganized the docs so that there's now a new top-level grouping that the URL needs to include when using the anchor approach.
Find:
<a href="./\?path=/docs/(?!packages)
Replace:
<a href="./?path=/docs/packages-
Issue: WB-1733
Test plan:
yarn start:storybook
and check the new docs and changed links are working