From 49b8455a3bae1cd730a3514ee46227f643c8c489 Mon Sep 17 00:00:00 2001 From: Jon Friesen Date: Tue, 20 Aug 2024 12:01:52 -0600 Subject: [PATCH] adds FAQ --- README.md | 2 + docs/FAQ.md | 114 +++++++++++++++++++++++++++++++++ {misc => docs}/screenshot1.png | Bin {misc => docs}/screenshot2.png | Bin src/popup/popup.html | 2 + web/src/components/Intro.jsx | 2 +- 6 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 docs/FAQ.md rename {misc => docs}/screenshot1.png (100%) rename {misc => docs}/screenshot2.png (100%) diff --git a/README.md b/README.md index cc78a2c..25f304b 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ Want support for more sites? Please [submit an issue](https://github.com/jonfrie After installation, the QuickCite button will appear on supported pages. Click the button to copy the formatted information to your clipboard. +For frequently asked questions and user support, please refer to our [FAQ document](docs/FAQ.md). + ## Development To run the extension in development mode: diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 0000000..7f911dc --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,114 @@ +# QuickCite Chrome Extension FAQ + +## About QuickCite + +### What is QuickCite? + +QuickCite is a Chrome extension that allows you to quickly copy formatted information from supported websites (like GitHub, LinkedIn, and Instagram) with a single click. + +### Which websites does QuickCite support? + +Currently, QuickCite supports: + +- GitHub (repositories, issues, pull requests, discussions, user profiles) +- LinkedIn (user profiles, company pages, articles) +- Instagram (user profiles) + +### How do I use QuickCite? + +Once installed, QuickCite will add a button to supported web pages. Click this button to copy the formatted information to your clipboard. + +## Installation and Setup + +### How do I install QuickCite? + +1. Go to the [Chrome Web Store](https://chromewebstore.google.com/detail/quickcite/bdkbkefnpcenapogkehakcgmffjbbkif). +2. Click "Add to Chrome". +3. Click "Add extension" in the popup. + +### Why can't I see the QuickCite button on supported websites? + +If you can't see the button: + +1. Ensure the extension is enabled in Chrome. +2. Try refreshing the page. +3. Check if the site is enabled in the extension's popup menu. + +## Using QuickCite + +### How do I change the format of the copied text? + +1. Click on the QuickCite icon in your Chrome toolbar. +2. In the popup, select either "Markdown Format" or "Plain Text Format". + +### Can I customize the prefix for each website? + +Yes, you can: + +1. Click on the QuickCite icon in your Chrome toolbar. +2. In the popup, find the website you want to customize. +3. Edit the text in the "Prefix" field next to the website name. + +### How do I enable or disable QuickCite for specific websites? + +1. Click on the QuickCite icon in your Chrome toolbar. +2. In the popup, use the toggle switch next to each website to enable or disable it. + +## Troubleshooting + +### The extension isn't working. What should I do? + +Try these steps: + +1. Refresh the webpage. +2. Disable and re-enable the extension. +3. Restart your browser. +4. If the issue persists, try uninstalling and reinstalling the extension. + +### Why isn't the copied text formatting correctly? + +Ensure you've selected the correct format (Markdown or Plain Text) in the extension popup. If the issue persists, please report it as a bug. + +### The extension is slowing down my browser. What can I do? + +QuickCite is designed to be lightweight, but if you notice performance issues: + +1. Disable the extension for sites you don't frequently use. +2. Check if the issue persists with other extensions disabled. +3. If the problem continues, please report it as a bug. + +## General Chrome Extension Troubleshooting + +### How do I update Chrome extensions? + +Chrome usually updates extensions automatically. To manually update: + +1. Go to `chrome://extensions/` +2. Enable "Developer mode" at the top right. +3. Click "Update" at the top left. + +### How do I enable/disable an extension? + +1. Go to `chrome://extensions/` +2. Find the extension and use the toggle switch to enable/disable it. + +### How do I uninstall an extension? + +1. Go to `chrome://extensions/` +2. Find the extension and click "Remove". + +### An extension isn't working in Incognito mode. How do I fix this? + +1. Go to `chrome://extensions/` +2. Find the extension and click "Details". +3. Scroll down and toggle on "Allow in Incognito". + +## Feedback and Support + +### How do I report a bug or suggest a feature? + +Please visit our [GitHub repository](https://github.com/jonfriesen/quickcite/issues/new/choose) to submit an issue or feature request or submit feedback on our [website](https://quickcite.link). + +--- + +We hope this FAQ helps you get the most out of QuickCite! If you have any other questions, don't hesitate to reach out. diff --git a/misc/screenshot1.png b/docs/screenshot1.png similarity index 100% rename from misc/screenshot1.png rename to docs/screenshot1.png diff --git a/misc/screenshot2.png b/docs/screenshot2.png similarity index 100% rename from misc/screenshot2.png rename to docs/screenshot2.png diff --git a/src/popup/popup.html b/src/popup/popup.html index a6006bb..a8ebf53 100644 --- a/src/popup/popup.html +++ b/src/popup/popup.html @@ -54,6 +54,8 @@

Site Configurations:

QuickCite | + FAQ + | made by Jon
diff --git a/web/src/components/Intro.jsx b/web/src/components/Intro.jsx index ef317c1..96968a5 100644 --- a/web/src/components/Intro.jsx +++ b/web/src/components/Intro.jsx @@ -140,7 +140,7 @@ export function Intro() {

- + Documentation