Skip to content

Commit

Permalink
docs: rename to fuji-web
Browse files Browse the repository at this point in the history
  • Loading branch information
@mondaychen
mondaychen committed May 21, 2024
1 parent f9abbae commit 7d26449
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 40 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Contributing to WebWand
# Contributing to Fuji-Web

Thank you for your interest in contributing to WebWand! WebWand is a tool that simplifies web interactions through the innovative use of multi-modal Large Language Models, offering users a more intuitive and efficient online experience. We welcome contributions from the community to help make WebWand even better.
Thank you for your interest in contributing to Fuji-Web! Fuji-Web is a tool that simplifies web interactions through the innovative use of multi-modal Large Language Models, offering users a more intuitive and efficient online experience. We welcome contributions from the community to help make Fuji-Web even better.

## How to Contribute

There are many ways to contribute to WebWand, from writing code to improving documentation, reporting bugs, and suggesting enhancements. Here's how you can get started:
There are many ways to contribute to Fuji-Web, from writing code to improving documentation, reporting bugs, and suggesting enhancements. Here's how you can get started:

### Spread the Word
If you love WebWand, you can make a big difference by telling others about it. Write a blog post, talk about it on social media, or share your experience with friends and colleagues. Every bit helps in growing our community and bringing new contributors on board.
If you love Fuji-Web, you can make a big difference by telling others about it. Write a blog post, talk about it on social media, or share your experience with friends and colleagues. Every bit helps in growing our community and bringing new contributors on board.

### Reporting Bugs

Before reporting a new bug, please ensure that the issue has not already been reported. You can do this by searching through the existing issues in our GitHub repository.

If you encounter a bug while using WebWand and it has not been reported yet, please report it by creating a new issue. Be sure to include:
If you encounter a bug while using Fuji-Web and it has not been reported yet, please report it by creating a new issue. Be sure to include:

- A clear and descriptive title
- A detailed description of the bug, including steps to reproduce it
- Any relevant screenshots or error messages
- Your WebWand version and browser details
- Your Fuji-Web version and browser details

### Suggesting Enhancements

We're always looking for ways to improve WebWand. If you have an idea for a new feature or an enhancement to an existing one, please submit it as an issue, using a clear and concise title and description. Explain why this enhancement would be useful, and if possible, include examples of how it could be implemented.
We're always looking for ways to improve Fuji-Web. If you have an idea for a new feature or an enhancement to an existing one, please submit it as an issue, using a clear and concise title and description. Explain why this enhancement would be useful, and if possible, include examples of how it could be implemented.

### Contributing Code

Expand All @@ -40,16 +40,16 @@ Before submitting your first code contribution, please make sure to:

- Ensure that your code follows the project's coding conventions and is properly documented.
- Include screenshots or animated GIFs in your pull request whenever possible, especially for UI-related changes.
- Follow the [Pull Request Template](https://github.com/normal-computing/web-wand/PULL_REQUEST_TEMPLATE.md) provided in the repository for the description of your pull request.
- Follow the [Pull Request Template](https://github.com/normal-computing/fuji-web/PULL_REQUEST_TEMPLATE.md) provided in the repository for the description of your pull request.

### Code Review Process

After you submit a pull request, the project maintainers will review your proposed changes. This process helps to ensure the quality and consistency of the WebWand codebase. The review may require some back-and-forth communication, so please be patient. We appreciate your contributions and will do our best to provide feedback and guidance as quickly as possible.
After you submit a pull request, the project maintainers will review your proposed changes. This process helps to ensure the quality and consistency of the Fuji-Web codebase. The review may require some back-and-forth communication, so please be patient. We appreciate your contributions and will do our best to provide feedback and guidance as quickly as possible.

## Community and Conduct

We are committed to providing a welcoming and inspiring community for all. We encourage all contributors to foster an open and welcoming environment, and to be respectful of differing viewpoints and experiences.

## Acknowledgements

Your contributions help make WebWand a better tool for everyone. We look forward to your ideas, feedback, and contributions. Thank you for being part of the WebWand community! Happy contributing!
Your contributions help make Fuji-Web a better tool for everyone. We look forward to your ideas, feedback, and contributions. Thank you for being part of the Fuji-Web community! Happy contributing!
10 changes: 5 additions & 5 deletions CONTRIBUTING_KNOWLEDGE.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Prior Knowledge Augmentation

WebWand's Prior Knowledge Augmentation system is designed to enhance the tool's web navigation and task execution capabilities by leveraging a shared knowledge base. Contributions to this system help make WebWand smarter and more capable.
Fuji-Web's Prior Knowledge Augmentation system is designed to enhance the tool's web navigation and task execution capabilities by leveraging a shared knowledge base. Contributions to this system help make Fuji-Web smarter and more capable.

## What Kind of Knowledge Are We Looking For?

Expand All @@ -14,14 +14,14 @@ For example, if a website has two buttons with the same name but different funct
## How to Add and Test New Knowledge

We offer two convenient ways to add and test new knowledge in real-time:
- Via Form: Within the WebWand UI settings, navigate to the "Custom Knowledge Base" and select "Add Host Knowledge with Form" to input new knowledge using a user-friendly form.
- Via Form: Within the Fuji-Web UI settings, navigate to the "Custom Knowledge Base" and select "Add Host Knowledge with Form" to input new knowledge using a user-friendly form.
- Via JSON: If you prefer to work directly with JSON, choose "Add Host Knowledge with JSON" to enter your custom knowledge.

You can test the new knowledge by running several tasks on the relevant web pages to ensure WebWand behaves as expected.
You can test the new knowledge by running several tasks on the relevant web pages to ensure Fuji-Web behaves as expected.

Once you've tested various knowledge inputs and are satisfied with the new knowledge's performance, you can then copy that knowledge into the db.json file.

1. Locate the `db.json` file in the `src/helpers/knowledge` directory of the WebWand repository.
1. Locate the `db.json` file in the `src/helpers/knowledge` directory of the Fuji-Web repository.
2. Add your knowledge in the JSON format, following the existing structure. `annotationRules` is optional.
```json
{
Expand Down Expand Up @@ -49,4 +49,4 @@ Once you've tested various knowledge inputs and are satisfied with the new knowl

## Submitting Your Contribution

Please check out the [Contribution Guide](CONTRIBUTING.md). Share your testing process and results in your pull request to help reviewers understand the impact of your contribution. Specifically, describe how the new knowledge help WebWand acheive something it previously cannot perform correctly.
Please check out the [Contribution Guide](CONTRIBUTING.md). Share your testing process and results in your pull request to help reviewers understand the impact of your contribution. Specifically, describe how the new knowledge help Fuji-Web acheive something it previously cannot perform correctly.
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
<img src="public/icon-128.png" alt="Fuji-web Logo" width="100"/>

# WebWand: Vision based Full Browser Automation 🪄
# Fuji-Web: Vision based Full Browser Automation 🪄

[Demo](https://twitter.com/mengdi_en/status/1721965940680565166)

WebWand is a tool that redefines web interaction, making complex online tasks as simple as uttering a single command.
Fuji-Web is a tool that redefines web interaction, making complex online tasks as simple as uttering a single command.

Crafted on top of the innovative fusion of multi-modal Large Language Models (GPT-4V), WebWand embodies a sophisticated Web AI Partner. Imagine having an intelligent companion that not only grasps your intent but also possesses a broad awareness of website content, enabling it to autonomously execute tasks on your behalf and augment your workflow. With WebWand, this vision becomes reality.
Crafted on top of the innovative fusion of multi-modal Large Language Models (GPT-4V), Fuji-Web embodies a sophisticated Web AI Partner. Imagine having an intelligent companion that not only grasps your intent but also possesses a broad awareness of website content, enabling it to autonomously execute tasks on your behalf and augment your workflow. With Fuji-Web, this vision becomes reality.

## How does it work?

WebWand leverages the power of multi-modal Large Language Model, DOM state awareness, and semantic understanding of HTML to focus on essential webpage elements while filtering out noise.
Fuji-Web leverages the power of multi-modal Large Language Model, DOM state awareness, and semantic understanding of HTML to focus on essential webpage elements while filtering out noise.

Here is an example of WebWand annotating the website to better understand the environment.
Here is an example of Fuji-Web annotating the website to better understand the environment.
<img src="media/web-annotation.png" alt="Screenshot of annotated website" width="50%" style="display: block; margin: 0 auto"/>


It also features a unique "Prior Knowledge Augmentation" system that allows WebWand to navigate websites with the wisdom of collective past experiences, crowdsourced from WebWand users.
It also features a unique "Prior Knowledge Augmentation" system that allows Fuji-Web to navigate websites with the wisdom of collective past experiences, crowdsourced from Fuji-Web users.

We do NOT collect your screenshots, browsing information or your prompts. It lives in your browser and is directly sent to the LLM API of your choice.

## Installing and Running

### Download and Install the extension in your browser

1. Go to the [releases page](https://github.com/normal-computing/fuji-web/releases), find the latest version of the extension and download "webwand.zip".
1. Go to the [releases page](https://github.com/normal-computing/fuji-web/releases), find the latest version of the extension and download "Fuji-Web.zip".
2. Unzip the file.
3. Load your extension on Chrome by doing the following:
1. Navigate to `chrome://extensions/`
Expand All @@ -36,9 +36,9 @@ We do NOT collect your screenshots, browsing information or your prompts. It liv

*Please note that you might need to refresh the page for the extension to work.*

1. Find the WebWand icon in the top right corner of your browser and click on it to open the sidepanel.
1. Find the Fuji-Web icon in the top right corner of your browser and click on it to open the sidepanel.
2. The next thing you need to do is create or access an existing [OpenAI API Key](https://platform.openai.com/account/api-keys) and paste it in the provided box. This key will be stored securely in your browser, and will not be uploaded to a third party.
3. Finally, navigate to a webpage you want WebWand and type in the task you want it to perform.
3. Finally, navigate to a webpage you want Fuji-Web and type in the task you want it to perform.

### Build the extension

Expand All @@ -55,27 +55,27 @@ When loading the extension, you will need to load the `dist` folder created by t
## Roadmap

- Expose API for easy integration with browser automation frameworks (e.g. Puppeteer, Playwright, Selenium)
- Evaluate the performance of the WebWand in real-world scenarios
- Evaluate the performance of the Fuji-Web in real-world scenarios
- Add support for more complex & cross-tab workflows
- Add support for more AI Models
- Add support for more browsing behaviors (select from dropdown, extract text etc.)
- Add support for saving workflows
- Add support for sharing workflows & knowledge with others
- Create wikipedia-like knowledge base where users can work together to create knowledge that can improve the WebWand's performance
- Create wikipedia-like knowledge base where users can work together to create knowledge that can improve the Fuji-Web's performance

## Troubleshooting

Check out our [Troubleshooting Guide](TROUBLESHOOTING.md) for help with common problems.

## Contributing

Interested in contributing to WebWand? We'd love your help! Check out our [Contribution Guide](CONTRIBUTING.md) for guidelines on how to contribute, report bugs, suggest enhancements, and more.
Interested in contributing to Fuji-Web? We'd love your help! Check out our [Contribution Guide](CONTRIBUTING.md) for guidelines on how to contribute, report bugs, suggest enhancements, and more.

We also encourage everyone in the community to add new knowledge to the "Prior Knowledge Augmentation" system to make WebWand even smarter. For detailed instructions on what kind of knowledge we're looking for and how to test and submit it, please see our [Contributing Knowledge Guide](CONTRIBUTING_KNOWLEDGE.md).
We also encourage everyone in the community to add new knowledge to the "Prior Knowledge Augmentation" system to make Fuji-Web even smarter. For detailed instructions on what kind of knowledge we're looking for and how to test and submit it, please see our [Contributing Knowledge Guide](CONTRIBUTING_KNOWLEDGE.md).

## Credits

- WebWand's image annotation method was inspired by Microsoft's [UFO paper](https://arxiv.org/abs/2402.07939).
- Fuji-Web's image annotation method was inspired by Microsoft's [UFO paper](https://arxiv.org/abs/2402.07939).
- Web Agent as a tool that lives in the browser sidepanel was inspired by [TaxyAI's browser extension](https://github.com/TaxyAI/browser-extension). We also used some of its UI code.
- The Chrome extension set-up leveraged an awesome boilerplate project [Jonghakseo/chrome-extension-boilerplate-react-vite](https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite).
- The Fuji logo is from [Toss Face](https://emojipedia.org/toss-face) Emoji design set.
22 changes: 11 additions & 11 deletions TROUBLESHOOTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Troubleshooting Guide for WebWand
# Troubleshooting Guide for Fuji-Web

This guide aims to help you diagnose and resolve common problems you might encounter. If you're still facing difficulties after following these steps, please reach out to us through our [GitHub Issues](https://github.com/normal-computing/fuji-web/issues).

Expand All @@ -7,10 +7,10 @@ This guide aims to help you diagnose and resolve common problems you might encou

### Extension Not Loading

**Symptom**: The WebWand extension doesn't appear in your browser or won't load.
**Symptom**: The Fuji-Web extension doesn't appear in your browser or won't load.

**Solutions**:
1. Ensure your browser is compatible with WebWand. Currently, WebWand supports Chrome.
1. Ensure your browser is compatible with Fuji-Web. Currently, Fuji-Web supports Chrome.
2. Verify that `Developer mode` is enabled in `chrome://extensions/`
3. (Only when you are building it from source) Make sure you've loaded the extension from the `dist` folder.
4. Restart your browser as this can resolve many loading issues.
Expand All @@ -25,27 +25,27 @@ This guide aims to help you diagnose and resolve common problems you might encou

### Dom Actions Problems

**Symptom**: WebWand did not perform dom actions properly.
**Symptom**: Fuji-Web did not perform dom actions properly.

**Solutions**:
1. Currently, WebWand does not support running in the background. If you open a new tab or navigate away from the website that WebWand is working on, some actions may fail. Please stay on the website where you execute WebWand.
1. Currently, Fuji-Web does not support running in the background. If you open a new tab or navigate away from the website that Fuji-Web is working on, some actions may fail. Please stay on the website where you execute Fuji-Web.

### Custom Knowledge Base Problems

**Symptom**: After adding custom knowledge, WebWand crashed or did not perform according to the new knowledge about the active tab.
**Symptom**: After adding custom knowledge, Fuji-Web crashed or did not perform according to the new knowledge about the active tab.

**Solutions**:
1. Currently, WebWand only supports basic entry validation for custom knowledge. Make sure you entered the correct host name and correct regular expressions if using a custom URL Matching Pattern.
1. Currently, Fuji-Web only supports basic entry validation for custom knowledge. Make sure you entered the correct host name and correct regular expressions if using a custom URL Matching Pattern.

### Voice Mode Problems

**Symptom**: WebWand did not capture speech.
**Symptom**: Fuji-Web did not capture speech.

**Solutions**:
1. Check if WebWand has microphone access in the browser. When you turn on the voice mode in settings, the microphone access dialog should pop up in the browser; please select "allow".
2. If the dialog didn't pop up, right-click the WebWand icon in the extensions group and select "View Web Permissions". Then select "Allow" for Microphone.
1. Check if Fuji-Web has microphone access in the browser. When you turn on the voice mode in settings, the microphone access dialog should pop up in the browser; please select "allow".
2. If the dialog didn't pop up, right-click the Fuji-Web icon in the extensions group and select "View Web Permissions". Then select "Allow" for Microphone.


## Reporting New Issues

If you encounter a problem not covered in this guide, please help us by reporting it. Provide as much detail as possible, including steps to reproduce the issue, browser version, and any error messages you receive. Your reports are invaluable in helping us improve WebWand.
If you encounter a problem not covered in this guide, please help us by reporting it. Provide as much detail as possible, including steps to reproduce the issue, browser version, and any error messages you receive. Your reports are invaluable in helping us improve Fuji-Web.

0 comments on commit 7d26449

Please sign in to comment.