docs(readme): fix ThemeProvider import path in Theming example#223
Open
andrerfneves wants to merge 1 commit into
Open
docs(readme): fix ThemeProvider import path in Theming example#223andrerfneves wants to merge 1 commit into
andrerfneves wants to merge 1 commit into
Conversation
The README Theming code example showed an import using a `@/` path alias (`@/components/theme-provider`), but the project does not configure this alias. The actual source files use relative imports. Changed to `./components/theme-provider` to match the actual project import pattern and ensure the example works when copied verbatim. Note: The `storageKey` value in the same example is addressed separately in PR #194.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Fixes the Theming code example in the README to use a relative import path instead of a non-existent
@/path alias.Why
The README Theming code example showed:
But the project does not configure the
@/path alias. The actual source files (app.tsx,main.tsx) all use relative imports:A user copying the example verbatim would get a module resolution error. Changing to
./components/theme-providerensures the example works without additional configuration.Changes
README.md: Changed@/components/theme-provider→./components/theme-providerin the Theming section code exampleNote
This PR only fixes the import path. The
storageKeyvalue in the same code block (ui-theme→lightning-decoder-theme) is addressed separately in PR #194.Test Plan