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

add webwand ui to readme #135

Merged
merged 5 commits into from
Apr 23, 2024
Merged

add webwand ui to readme #135

merged 5 commits into from
Apr 23, 2024

Conversation

lynchee-owo
Copy link
Contributor

@lynchee-owo lynchee-owo commented Apr 23, 2024

Description

Resolve #133

Type of Change

  • Documentation update

Demo

Screenshot 2024-04-23 at 3 37 20 PM

@lynchee-owo lynchee-owo requested a review from mondaychen as a code owner April 23, 2024 15:33
@lynchee-owo lynchee-owo requested a review from cemigo114 April 23, 2024 15:33
@lynchee-owo lynchee-owo changed the title Lynchee/readme add webwand ui to readme Apr 23, 2024
Copy link
Contributor

@mondaychen mondaychen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything in "public" folder is packed into the extension. Since this image is for README only, let's create a new folder for it.

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -16,6 +16,8 @@ It also features a unique "Prior Knowledge Augmentation" system that allows WebW

We do NOT record your screen or collect browsing information or your prompts. It lives in your browser and uses your OpenAI key.

<img src="public/webwand_screenshot.png" alt="Screenshot of annotated website" width="50%" style="display: block; margin: 0 auto"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's strange this image is added here without additional context.

Maybe move it up a bit (right after "WebWand leverages the power of multi-modal..." paragrapgh) would be better. And you can add some words to introduce the image, such as "This is an example of an annotated website"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@lynchee-owo lynchee-owo merged commit 3aba643 into main Apr 23, 2024
3 checks passed
@mondaychen mondaychen deleted the lynchee/readme branch May 23, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add screenshot of webwand UI and also the screenshot of annotated website
2 participants