Update installation instructions for non-compiled projects#283
Merged
theoluciano merged 3 commits intomainfrom Jun 27, 2025
Merged
Update installation instructions for non-compiled projects#283theoluciano merged 3 commits intomainfrom
theoluciano merged 3 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates installation instructions to cover usage scenarios without a build step (e.g., CodePen or CDN).
- Adds a new “Importing without a compiler” section to both the README and Storybook introduction
- Provides CDN link and CSS
@importexamples for non-compiled environments
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/stories/Overview/Introduction.mdx | Added CDN import examples and CodePen usage notes |
| README.md | Added CDN import examples and CodePen usage notes |
Comments suppressed due to low confidence (4)
src/stories/Overview/Introduction.mdx:87
- The placeholder
[desired version]in the URL can be mistaken as literal brackets. Consider clarifying that users should replace it (e.g.,@rolemodel/optics@1.2.3) without the square brackets.
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@rolemodel/optics@[desired version]/dist/css/optics.min.css">
README.md:49
- The placeholder
[desired version]may be confusing if interpreted literally. Clarify that users should substitute it with the actual version number (e.g.,@rolemodel/optics@1.2.3).
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@rolemodel/optics@[desired version]/dist/css/optics.min.css">
src/stories/Overview/Introduction.mdx:91
- This CSS
@importstatement is missing a terminating semicolon, which will cause a syntax error. Please add;at the end.
@import "https://cdn.jsdelivr.net/npm/@rolemodel/optics@[desired version]/dist/css/optics.min.css"
README.md:53
- This CSS
@importrule is missing a trailing semicolon, which will break stylesheet parsing. Please append;to the end of the line.
@import "https://cdn.jsdelivr.net/npm/@rolemodel/optics@[desired version]/dist/css/optics.min.css"
Jeremy-Walton
approved these changes
Jun 27, 2025
Member
Jeremy-Walton
left a comment
There was a problem hiding this comment.
Looks like there are some linting errors that need to be resolved.
You can run yarn sanity-check to run through all the things the checklist asks about. I think it will fix the linting errors as well
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
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.
Task
TR #231
Why?
It would be good to give better installation instructions for cases like using Optics in CodePen, in a non-build environment, how to use from a CDN, etc.
What Changed
What changed in this PR?
Sanity Check
Screenshots