Dev.ej/web app docs #227
Merged
Dev.ej/web app docs #227
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #227 +/- ##
=======================================
Coverage 87.23% 87.23%
=======================================
Files 21 21
Lines 1770 1770
Branches 321 321
=======================================
Hits 1544 1544
Misses 189 189
Partials 37 37 ☔ View full report in Codecov by Sentry. |
deltork
approved these changes
Jul 10, 2024
| @@ -25,12 +38,13 @@ Below is an example of a minimal implementation in a basic standalone html page. | |||
| <!-- Here is how you declare the Web Component --> | |||
| <read-along href="assets/sample.readalong" audio="assets/sample.wav"></read-along> | |||
| </body> | |||
|
|
|||
| <!-- The last step needed is to import the package --> | |||
| <script type="module" src='https://unpkg.com/@readalongs/web-component@^1.4.0/dist/web-component/web-component.esm.js'</script> | |||
There was a problem hiding this comment.
^1.4.0 is the same as1.4.x, no?
|
checked it out. Looks good Eric. |
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.
PR Goal?
Add documentation for the ReadAlong Studio web app and web editor
Fixes?
This is part of ReadAlongs/Studio-Web#298
Feedback sought?
Read the documentation I wrote and let me know how you like it, if it should be improved, etc.
Priority?
this week if possible
Tests added?
n/a
How to test?
Serve locally:
and navigate to http://127.0.0.1:8000/web-app/
Or check it out pre-built at https://joanise.github.io/ReadAlong-Studio/dev/web-app/
Confidence?
medium
Version change?
no