Skip to content
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

docs: Improve content script UI docs #268

Merged
merged 6 commits into from
Dec 10, 2023
Merged

Conversation

aklinker1
Copy link
Collaborator

@aklinker1 aklinker1 commented Dec 10, 2023

This PR aims to improve readability of content script UI docs, as mentioned in #267.

  • Moved from /entrypoints/content-scripts.html to /guide/content-script-ui.html
  • Added visualizations for several options
  • Added a whole new section for "integrated" UIs
  • Better examples for all frameworks
  • Export more types so they show up in the API reference

@aklinker1 aklinker1 added the docs Improvements or additions to documentation label Dec 10, 2023
@aklinker1 aklinker1 self-assigned this Dec 10, 2023
Copy link

netlify bot commented Dec 10, 2023

Deploy Preview for creative-fairy-df92c4 ready!

Name Link
🔨 Latest commit 0e2ddfb
🔍 Latest deploy log https://app.netlify.com/sites/creative-fairy-df92c4/deploys/65754de9ad904c000814fb29
😎 Deploy Preview https://deploy-preview-268--creative-fairy-df92c4.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Dec 10, 2023

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (2ef28ec) 69.99% compared to head (0e2ddfb) 69.97%.

Files Patch % Lines
src/client/index.ts 0.00% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #268      +/-   ##
==========================================
- Coverage   69.99%   69.97%   -0.02%     
==========================================
  Files         133      133              
  Lines        7338     7365      +27     
  Branches      571      571              
==========================================
+ Hits         5136     5154      +18     
- Misses       2152     2161       +9     
  Partials       50       50              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aklinker1 aklinker1 marked this pull request as ready for review December 10, 2023 05:33
@aklinker1 aklinker1 changed the title docs: Improved content script UI docs docs: Improve content script UI docs Dec 10, 2023
@aklinker1 aklinker1 merged commit 21cf364 into main Dec 10, 2023
@aklinker1 aklinker1 deleted the improved-content-script-ui-docs branch December 10, 2023 05:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant