From e561f6d567d86affb316113a34929775fcac52f2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 12 Feb 2026 03:06:05 +0000 Subject: [PATCH] docs(browser): add quick start guide and test page for browser extension - Add QUICKSTART.md with 5-minute installation guide - Create test.html page for testing extension functionality - Include troubleshooting tips and testing checklist - Add sample document and image links for testing Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com> --- browser-extension/QUICKSTART.md | 123 +++++++++++++++++++++++++++ browser-extension/test.html | 143 ++++++++++++++++++++++++++++++++ 2 files changed, 266 insertions(+) create mode 100644 browser-extension/QUICKSTART.md create mode 100644 browser-extension/test.html diff --git a/browser-extension/QUICKSTART.md b/browser-extension/QUICKSTART.md new file mode 100644 index 00000000..7716adfd --- /dev/null +++ b/browser-extension/QUICKSTART.md @@ -0,0 +1,123 @@ +# Browser Extension - Quick Start Guide + +This guide will help you quickly install and configure the DocuElevate browser extension. + +## 5-Minute Installation + +### Step 1: Load the Extension + +**For Chrome/Edge/Chromium browsers:** + +1. Open your browser and navigate to: + - Chrome: `chrome://extensions/` + - Edge: `edge://extensions/` + - Other Chromium: Similar URL for your browser + +2. Enable **Developer mode** (toggle in top right corner) + +3. Click **"Load unpacked"** button + +4. Select the `browser-extension` folder from your DocuElevate installation + +5. The DocuElevate icon should now appear in your browser toolbar + +**For Firefox:** + +1. Navigate to `about:debugging#/runtime/this-firefox` + +2. Click **"Load Temporary Add-on..."** + +3. Select the `manifest.json` file from the `browser-extension` folder + +4. The extension will load (note: temporary, removed when Firefox restarts) + +### Step 2: Configure Your Server + +1. Click the DocuElevate extension icon in your toolbar + +2. Enter your DocuElevate server URL: + ``` + https://your-docuelevate-server.com + ``` + Or for local testing: + ``` + http://localhost:8000 + ``` + +3. Click **"Save Configuration"** + +### Step 3: (Optional) Add Authentication + +If your DocuElevate server requires authentication: + +1. Log in to your DocuElevate server in a regular browser tab + +2. Open Developer Tools (F12) + +3. Go to **Application** โ†’ **Cookies** (Chrome/Edge) or **Storage** โ†’ **Cookies** (Firefox) + +4. Find the cookie named `session` + +5. Copy its **Value** + +6. In the extension popup, click **"Change Settings"** + +7. Paste the value in the **Session Cookie** field: + ``` + session=your_copied_session_value + ``` + +8. Click **"Save Configuration"** + +### Step 4: Send Your First File + +1. Navigate to any page with a document URL, for example: + - `https://example.com/document.pdf` + - `https://example.com/image.jpg` + - Any direct link to a supported file + +2. Click the DocuElevate extension icon + +3. (Optional) Enter a custom filename + +4. Click **"Send to DocuElevate"** + +5. Wait for the success message! + +## Quick Tips + +- **Right-click shortcut**: Right-click on any link and select "Send to DocuElevate" +- **Notifications**: You'll get browser notifications for success/error +- **Change settings**: Click "Change Settings" in the extension popup anytime +- **Supported files**: PDF, Office docs, images - see full list in README + +## Troubleshooting + +**"Failed to connect to server"** +- Check your server URL is correct +- Make sure DocuElevate is running +- Verify network/firewall settings + +**"Authentication required"** +- Add your session cookie (see Step 3) +- Your session may have expired - log in again + +**"Unsupported file type"** +- URL must point to a document or image file +- Check that the URL has a file extension (.pdf, .docx, etc.) + +## Next Steps + +- Read the full [Browser Extension Guide](../docs/BrowserExtension.md) for detailed information +- Configure file processing settings in DocuElevate +- Set up storage destinations (Dropbox, Google Drive, etc.) + +## Need Help? + +- Check the [Troubleshooting Guide](../docs/Troubleshooting.md) +- Review the [API Documentation](../docs/API.md) +- Open an issue on [GitHub](https://github.com/christianlouis/DocuElevate/issues) + +--- + +Happy document processing! ๐Ÿš€ diff --git a/browser-extension/test.html b/browser-extension/test.html new file mode 100644 index 00000000..9fd92083 --- /dev/null +++ b/browser-extension/test.html @@ -0,0 +1,143 @@ + + + + + + Browser Extension Test Page + + + +

๐Ÿงช DocuElevate Browser Extension Test Page

+ +
+

How to Test

+
    +
  1. Make sure the DocuElevate browser extension is installed and configured
    2. +
  2. Test Method 1: Click the extension icon and send the current page URL
    3. +
  3. Test Method 2: Right-click on any link below and select "Send to DocuElevate"
    4. +
  4. Test Method 3: Navigate to a link below and then use the extension popup
    5. +
+
+ +
+

๐Ÿ“„ Sample Document Links

+

These links point to sample documents that can be processed by DocuElevate:

+ + + ๐Ÿ“• Sample PDF Document (dummy.pdf) + + + + ๐Ÿ“— Example PDF File (file-sample_150kB.pdf) + + + + ๐Ÿ“˜ Learning Container Sample PDF + +
+ +
+

๐Ÿ–ผ๏ธ Sample Image Links

+

These links point to sample images that can be processed:

+ + + ๐Ÿ–ผ๏ธ Placeholder Image (PNG, 800x600) + + + + ๐Ÿ“ท Placeholder Image (JPG, 1024x768) + +
+ +
+

โœ… Expected Behavior

+ +
+ +
+

๐Ÿ” Testing Checklist

+ +
+ +
+

๐Ÿ› Troubleshooting

+

If the extension doesn't work:

+
    +
  1. Check that the extension is enabled in chrome://extensions/
    2. +
  2. Verify your DocuElevate server URL is correct
    3. +
  3. Open DevTools (F12) and check the Console for errors
    4. +
  4. Make sure your DocuElevate server is running and accessible
    5. +
  5. If using authentication, verify your session cookie is valid
    6. +
+
+ + + +