docs: fix incorrect imports in InputOTP and Tabs code examples#352
Open
faizkhairi wants to merge 1 commit into
Open
docs: fix incorrect imports in InputOTP and Tabs code examples#352faizkhairi wants to merge 1 commit into
faizkhairi wants to merge 1 commit into
Conversation
Replace internal alias `@/components/myds` with the public package path
`@govtechmy/myds-react/{component}` in documentation code blocks.
Fixes govtechmy#290
Only code examples (inside ``` blocks) are updated. Top-level MDX imports
remain as `@/components/myds` since the docs app barrel file needs them
for live component rendering.
- input-otp.mdx / input-otp.ms.mdx: 6 code blocks each
- tabs.mdx / tabs.ms.mdx: 5-6 code blocks each
|
|
@faizkhairi is attempting to deploy a commit to the MyDIGITAL GNU Team on Vercel. A member of the Team first needs to authorize it. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #290
Summary
Documentation code examples for InputOTP and Tabs components use the internal docs-app alias
@/components/mydsinstead of the public package path@govtechmy/myds-react/{component}. Users copying these examples would get module resolution errors.What changed
Replaced import paths only inside code blocks (the copy-paste examples shown to developers):
from "@/components/myds"from "@govtechmy/myds-react/input-otp"from "@/components/myds"from "@govtechmy/myds-react/tabs"Files changed (4)
input-otp.mdxinput-otp.ms.mdxtabs.mdxtabs.ms.mdxWhat was NOT changed
Top-level MDX imports (e.g., line 9 of
input-otp.mdx) remain as@/components/myds. These are consumed by the docs app's barrel re-export file (apps/docs/components/myds.tsx) for live component rendering and must stay as-is.Verified against
The correct pattern matches other component docs (e.g.,
button.mdxline 40 uses@govtechmy/myds-react/button).