Create a privacy policy

Author: MrBlankCoding

README.md

@@ -72,3 +72,8 @@ npm run docs:build
 ## License
 
 MIT. See `LICENSE.txt`.
+
+## Privacy Policy
+
+- Docs page: `https://mrblankcoding.github.io/CodeTweak/guide/privacy`
+- Source page: `docs-src/guide/privacy.md`

docs-src/.vitepress/config.mjs

@@ -20,7 +20,8 @@ export default defineConfig({
         items: [
           { text: 'Getting Started', link: '/guide/getting-started' },
           { text: 'Install CodeTweak', link: '/guide/installation' },
-          { text: 'Use the Editor', link: '/guide/editor' },
+          { text: 'Using the Editor', link: '/guide/editor' },
+          { text: 'Writing Userscripts', link: '/guide/writing-userscripts' },
           { text: 'Manage Scripts', link: '/guide/dashboard' },
           { text: 'Install From Greasy Fork', link: '/guide/greasyfork' },
           { text: 'Privacy and Permissions', link: '/guide/privacy' }
@@ -29,7 +30,17 @@ export default defineConfig({
       {
         text: 'Reference',
         items: [
-          { text: 'GM APIs', link: '/reference/gm-apis' },
+          { 
+            text: 'GM APIs', 
+            link: '/reference/gm-apis',
+            items: [
+              { text: 'Storage & Data', link: '/reference/gm-apis/storage' },
+              { text: 'UI & Elements', link: '/reference/gm-apis/ui' },
+              { text: 'Network & Clipboard', link: '/reference/gm-apis/network' },
+              { text: 'Resources', link: '/reference/gm-apis/resources' },
+              { text: 'Advanced & Utility', link: '/reference/gm-apis/advanced' }
+            ]
+          },
           { text: 'Run Timing', link: '/reference/run-timing' },
           { text: 'Match Patterns', link: '/reference/match-patterns' }
         ]

docs-src/guide/editor.md

@@ -1,57 +1,44 @@
-# Use the Editor
+# Using the Editor
 
-CodeTweak has two editing modes:
+This guide covers the features and workflow of the CodeTweak script editor.
 
-- Standard script editor
-- AI DOM Editor sidebar
+## Opening the Editor
 
-## Standard editor workflow
+You can access the editor in two ways:
+1.  **Create a New Script**: Click the **CodeTweak icon** in your browser toolbar and select **Create Script**.
+2.  **Edit an Existing Script**: Go to the **Dashboard** and click on any script in the list.
 
-1. Set metadata.
-2. Write script code.
-3. Save.
-4. Test on a matching URL.
+## The Editor Interface
 
-Minimal metadata template:
+The editor is split into several key areas:
 
-```javascript
-// ==UserScript==
-// @name        My Script
-// @match       https://app.example.com/*
-// @run-at      document-end
-// @grant       GM_getValue
-// @grant       GM_setValue
-// ==/UserScript==
-```
+### 1. Code Editor (Center)
+The main window where you write your JavaScript and metadata block. It features syntax highlighting, auto-completion, and basic linting.
 
-State example:
+### 2. Header & Toolbar (Top)
+-   **Save**: Saves your script and immediately applies it to matched pages.
+-   **Settings**: Opens the editor's display and behavior settings.
+-   **Close**: Closes the editor and returns to the previous view.
 
-```javascript
-(async () => {
-  const count = await GM_getValue("count", 0);
-  await GM_setValue("count", count + 1);
-  console.log("runs:", count + 1);
-})();
-```
+### 3. Sidebar Panels (Right)
+These panels allow you to configure your script without manually editing the metadata block:
+-   **Script Info**: Change the script's name, version, and description.
+-   **Execution Settings**: Manage `@match` patterns and `@run-at` timing.
+-   **GM API Access**: Toggle permissions for specific `GM_*` APIs.
+-   **External Resources**: Add `@require` and `@resource` links.
+-   **Script Errors**: View compilation and runtime errors for the current script.
 
-## AI DOM Editor workflow
+## The AI DOM Editor
 
-1. Open popup.
-2. Click `AI DOM Editor`.
-3. Click `Select Element` in sidebar.
-4. Click target element on page.
-5. Enter instruction.
+The AI DOM Editor is a powerful tool for generating userscript code by simply describing what you want to change on a webpage.
 
-Example instructions:
+1.  **Open AI Sidebar**: Click **AI DOM Editor** in the popup or from the editor's sidebar.
+2.  **Select an Element**: Click the **Select Element** button and hover over the element on the page you want to modify.
+3.  **Describe the Change**: In the text box, describe what you want the AI to do (e.g., "Hide this element" or "Change the background color to blue").
+4.  **Review and Apply**: The AI will generate code for you. You can review it and click **Apply to Script** to add it to your current userscript.
 
-- `Hide this element`
-- `Change this button text to "Checkout"`
-- `Add red border to this card`
+## Debugging and Testing
 
-Review generated code before saving.
-
-## Common mistakes
-
-- `@match` too broad (`*://*/*`) or too narrow.
-- Wrong `@run-at` for the DOM state you expect.
-- Missing `@grant` for GM APIs.
+-   **Live Updates**: When you save a script, it is instantly updated. Refresh the target website to see your changes.
+-   **Console Logs**: Use `console.log()` in your script and open the browser's DevTools (F12) to see output.
+-   **Error Highlighting**: If your script has syntax errors, they will be highlighted in the **Script Errors** panel.

docs-src/guide/getting-started.md

@@ -39,6 +39,7 @@ console.log("CodeTweak script running");
 
 Next:
 
-- [Use the Editor](/guide/editor)
+- [Using the Editor](/guide/editor)
+- [Writing Userscripts](/guide/writing-userscripts)
 - [Manage Scripts](/guide/dashboard)
 - [GM API Reference](/reference/gm-apis)

docs-src/guide/privacy.md

@@ -1,25 +1,60 @@
-# Privacy and Permissions
+# Privacy Policy
 
-CodeTweak runs locally and stores data in extension storage.
+Last updated: February 18, 2026
 
-## Stored data
+CodeTweak is a browser extension for creating and running userscripts. This policy explains what data CodeTweak handles and how it is used.
 
-- Userscript code
-- Script settings
-- Extension settings
+## Summary
 
-## Permission map
+- CodeTweak processes script data locally in your browser.
+- CodeTweak does not sell personal information.
+- CodeTweak does not run a remote tracking or analytics service.
 
-- `storage`: save scripts/settings
-- `scripting`, `webNavigation`: run scripts at chosen timing
-- `tabs`: target active tab
-- `notifications`: GM/system notifications
-- `downloads`: export scripts
-- `clipboardWrite`: clipboard support
-- `contextMenus`: selector and menu actions
+## Data CodeTweak handles
+
+CodeTweak may handle the following data:
+
+- Userscript code and metadata (for scripts you create or import)
+- Script execution settings and extension settings
+- Stored values written by scripts via supported GM storage APIs
+- Limited page context required to decide when scripts should run (for example, current tab URL matching)
+
+## How data is used
+
+Data is used only to provide extension functionality, including:
+
+- Saving and loading scripts and settings
+- Matching scripts to pages and run timing
+- Running script features such as notifications, clipboard support, and downloads when triggered by you or your scripts
+
+## Data sharing
+
+- CodeTweak itself does not sell or rent user data.
+- CodeTweak itself does not transmit extension telemetry for advertising or profiling.
+- Network requests can occur when you explicitly import scripts (for example, from Greasy Fork) or when a userscript you installed makes requests using supported APIs. Those requests are initiated by user action or script behavior you control.
+
+## Data retention and deletion
+
+- Data is stored in browser extension storage until you remove it.
+- You can delete data by removing scripts/settings in CodeTweak, resetting extension data, or uninstalling the extension.
+
+## Permissions and purpose
+
+- `storage`: save scripts and settings
+- `scripting`, `webNavigation`: determine matching pages and run scripts at the selected timing
+- `tabs`: target the active tab for editor and execution flows
+- `notifications`: show extension or script notifications
+- `downloads`: export scripts/files when requested
+- `clipboardWrite`: copy text when requested
+- `contextMenus`: enable selector/editor context actions
+
+## Third-party content and scripts
+
+Userscripts are third-party code chosen by you. Installed scripts may process page data or make network requests according to their own logic. Review script source and metadata before enabling.
 
 ## Security guidance
 
 - Keep `@match` patterns specific.
-- Keep `Allow external resources` off unless required.
+- Keep external resource loading disabled unless needed.
 - Review imported scripts before enabling.
+

docs-src/guide/writing-userscripts.md

@@ -0,0 +1,92 @@
+# Writing Userscripts
+
+This guide explains how to write userscripts for CodeTweak, assuming you are already familiar with JavaScript.
+
+## The Metadata Block
+
+Every userscript starts with a metadata block (also known as the userscript header). This block tells CodeTweak when and where to run your script.
+
+```javascript
+// ==UserScript==
+// @name        My Awesome Script
+// @namespace   https://mrblankcoding.github.io/CodeTweak/
+// @version     1.0
+// @description Does something amazing
+// @author      You
+// @match       https://example.com/*
+// @grant       GM_setValue
+// @grant       GM_getValue
+// @run-at      document-end
+// ==/UserScript==
+```
+
+### Key Metadata Tags
+
+- **@name**: The name of your script.
+- **@match**: Defines the URLs where your script should run. You can use wildcards (e.g., `*`).
+- **@run-at**: Controls when the script executes:
+  - `document-start`: Runs before any DOM is loaded.
+  - `document-end`: Runs when the DOM is fully loaded.
+  - `document-idle`: Runs after the page and all resources are loaded.
+- **@grant**: Requests access to specific `GM_*` APIs. Use `none` if you don't need any.
+- **@require**: Includes external libraries (e.g., jQuery).
+
+## Structuring Your Script
+
+It is best practice to wrap your script in an Immediately Invoked Function Expression (IIFE) to avoid polluting the global scope and to prevent conflicts with the website's own scripts.
+
+```javascript
+(function() {
+    'use strict';
+
+    // Your code here
+    console.log('Script loaded on ' + window.location.href);
+
+    const button = document.createElement('button');
+    button.textContent = 'Click Me';
+    button.style.position = 'fixed';
+    button.style.top = '10px';
+    button.style.right = '10px';
+    button.onclick = () => alert('Hello from CodeTweak!');
+    
+    document.body.appendChild(button);
+})();
+```
+
+## Using GM APIs
+
+CodeTweak provides several APIs to perform tasks that standard web scripts cannot, such as cross-origin requests or persistent storage.
+
+### Persistent Storage
+
+Use `GM_setValue` and `GM_getValue` to store data that persists across page reloads and even browser restarts.
+
+```javascript
+// Store a value
+GM_setValue('username', 'Alice');
+
+// Retrieve a value
+const name = GM_getValue('username', 'Guest');
+console.log('Hello, ' + name);
+```
+
+### Cross-Origin Requests
+
+Use `GM_xmlhttpRequest` to fetch data from domains other than the one the script is running on.
+
+```javascript
+GM_xmlhttpRequest({
+    method: "GET",
+    url: "https://api.example.com/data",
+    onload: function(response) {
+        console.log(JSON.parse(response.responseText));
+    }
+});
+```
+
+## Best Practices
+
+1. **Be Specific with @match**: Only run your script on the pages it is needed for to improve performance and security.
+2. **Check for Element Existence**: When manipulating the DOM, always ensure the elements you are looking for exist, especially if using `document-start`.
+3. **Use 'use strict'**: Helps catch common coding mistakes.
+4. **Minimal @grant**: Only request the permissions you actually use.

docs-src/index.md

@@ -13,12 +13,15 @@ hero:
     - theme: alt
       text: GM API
       link: /reference/gm-apis
+    - theme: alt
+      text: Privacy Policy
+      link: /guide/privacy
 
 features:
-  - title: Fast setup
+  - title: Clean Workflow
     details: Build, load unpacked, and run a script in minutes.
-  - title: Practical editor
-    details: Metadata, linting, script logs, and one-click save.
+  - title: Modern editor
+    details: Metadata, linting, script logs, built in AI support
   - title: GM API support
     details: Persistent values, notifications, clipboard, and HTTP requests.
   - title: Debug workflow