Skip to content

Commit

Permalink
adds FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
jonfriesen committed Aug 20, 2024
1 parent 713e1ee commit 49b8455
Show file tree
Hide file tree
Showing 6 changed files with 119 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
114 changes: 114 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes
File renamed without changes
2 changes: 2 additions & 0 deletions src/popup/popup.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ <h2 class="mt-6 text-lg font-semibold mb-2">Site Configurations:</h2>
<div class="mt-6 text-center text-xs text-gray-500">
<a href="https://quickcite.link" target="_blank" rel="noopener noreferrer" class="hover:text-gray-300">QuickCite</a>
<span class="mx-2">|</span>
<a href="https://github.com/jonfriesen/quickcite/blob/main/docs/FAQ.md" target="_blank" rel="noopener noreferrer" class="hover:text-gray-300">FAQ</a>
<span class="mx-2">|</span>
<a href="https://jonfriesen.ca" target="_blank" rel="noopener noreferrer" class="hover:text-gray-300">made by Jon</a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion web/src/components/Intro.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export function Intro() {
</p>
<FeedbackForm />
<div className="mt-8 flex flex-wrap justify-center gap-x-1 gap-y-3 sm:gap-x-2 lg:justify-start">
<IconLink href="https://quickcite.link" icon={BookIcon} className="flex-none">
<IconLink href="https://github.com/jonfriesen/quickcite/blob/main/docs/FAQ.md" icon={BookIcon} className="flex-none">
Documentation
</IconLink>
<IconLink href="https://github.com/jonfriesen/quickcite" icon={GitHubIcon} className="flex-none">
Expand Down

0 comments on commit 49b8455

Please sign in to comment.