ref: separate docs file (#71) & edit links

Sv443-Network · Jan 22, 2025 · 962e8cd · 962e8cd
1 parent e95d835
commit 962e8cd
Show file tree

Hide file tree

Showing 7 changed files with 3,233 additions and 3,130 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -245,11 +245,11 @@
   - separate instances can have different MutationObserver options set to further reduce performance impact
   - the separation into instances allows for a new "chaining" paradigm where selector listeners are only added and checked for once they are actually needed (see examples in the documentation)
   - when using chaining, separate instances can be created and have listeners added to them before their base element is available in the DOM tree
-  - every listener can have a set debounce time, so that it doesn't get called too often (works the same as the [`debounce()` function](https://github.com/Sv443-Network/UserUtils/blob/main/README.md#debounce), but is disabled by default)
+  - every listener can have a set debounce time, so that it doesn't get called too often (works the same as the [`debounce()` function](https://github.com/Sv443-Network/UserUtils/blob/v3.0.0/README.md#debounce), but is disabled by default)
   - there are now multiple methods to get and delete specific listeners
 
   The `SelectorObserver.addListener()` method is backwards compatible with the old `onSelector()` function, so you can just add the class instance in front (for full backwards compat use `document.body` for the `baseElement` parameter of the constructor), then change the old function's name and it should work as before.
-  For more info and examples, please view the [SelectorObserver documentation](https://github.com/Sv443-Network/UserUtils/blob/main/README.md#selectorobserver)
+  For more info and examples, please view the [SelectorObserver documentation](https://github.com/Sv443-Network/UserUtils/blob/v3.0.0/README.md#selectorobserver)
 
 ### Minor Changes
 

diff --git a/README-summary.md b/README-summary.md
diff --git a/README.md b/README.md
diff --git a/docs.md b/docs.md
diff --git a/jsr.json b/jsr.json
@@ -9,9 +9,10 @@
       "dist/index.js",
       "dist/index.cjs",
       "dist/index.global.js",
+      "dist/index.umd.js",
       "dist/lib/**/*.d.ts",
       "package.json",
-      "README.md",
+      "README-summary.md",
       "CHANGELOG.md",
       "LICENSE.txt"
     ]

diff --git a/lib/Debouncer.ts b/lib/Debouncer.ts
@@ -3,7 +3,7 @@ import { NanoEmitter } from "./NanoEmitter.js";
 //#region types
 
 /**
- * The type of edge to use for the debouncer - [see the docs for a diagram and explanation.](https://github.com/Sv443-Network/UserUtils/blob/main/README.md#debouncer)  
+ * The type of edge to use for the debouncer - [see the docs for a diagram and explanation.](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer)  
  * - `immediate` - (default & recommended) - calls the listeners at the very first call ("rising" edge) and queues the latest call until the timeout expires  
  *   - Pros:  
  *     - First call is let through immediately  
@@ -52,7 +52,7 @@ export class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArgs>> {
   /**
    * Creates a new debouncer with the specified timeout and edge type.
    * @param timeout Timeout in milliseconds between letting through calls - defaults to 200
-   * @param type The edge type to use for the debouncer - see {@linkcode DebouncerType} for details or [the documentation for an explanation and diagram](https://github.com/Sv443-Network/UserUtils/blob/main/README.md#debouncer) - defaults to "immediate"
+   * @param type The edge type to use for the debouncer - see {@linkcode DebouncerType} for details or [the documentation for an explanation and diagram](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer) - defaults to "immediate"
    */
   constructor(protected timeout = 200, protected type: DebouncerType = "immediate") {
     super();
@@ -161,7 +161,7 @@ export class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArgs>> {
  * The returned function can be called with any arguments and will execute the `call()` method of the debouncer.  
  * The debouncer instance is accessible via the `debouncer` property of the returned function.  
  *   
- * Refer to the {@linkcode Debouncer} class definition or the [Debouncer documentation](https://github.com/Sv443-Network/UserUtils/blob/main/README.md#debouncer) for more information.
+ * Refer to the {@linkcode Debouncer} class definition or the [Debouncer documentation](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer) for more information.
  */
 export function debounce<
   TFunc extends DebouncerFunc<TArgs>,

diff --git a/package.json b/package.json
@@ -72,9 +72,10 @@
     "/dist/index.cjs",
     "/dist/index.mjs",
     "/dist/index.global.js",
+    "/dist/index.umd.js",
     "/dist/lib/**.d.ts",
     "/package.json",
-    "/README.md",
+    "/README-summary.md",
     "/CHANGELOG.md",
     "/LICENSE.txt"
   ]