wip

thoughtbot · Oct 7, 2024 · 54dda27 · 54dda27
1 parent be01759
commit 54dda27
Show file tree

Hide file tree

Showing 5 changed files with 183 additions and 179 deletions.
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -14,9 +14,13 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 18
+      - name: NPM install
+        working-directory: ./superglue
+        run: npm install
+
       - name: Build typedoc
         working-directory: ./superglue
-        run: npm install && npx typedoc
+        run: npx typedoc
 
       - uses: actions/setup-python@v5
         with:

diff --git a/docs/reference/components.Nav.md b/docs/reference/components.Nav.md
@@ -47,4 +47,4 @@ store.
 
 ###### Defined in
 
-[lib/components/Nav.tsx:85](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/components/Nav.tsx#L85)
+[lib/components/Nav.tsx:85](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/components/Nav.tsx#L85)
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -40,7 +40,7 @@ The constructor of the `ApplicationBase` class.
 
 ###### Defined in
 
-[lib/index.tsx:151](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L151)
+[lib/index.tsx:151](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L151)
 
 #### Methods
 
@@ -68,12 +68,12 @@ adding a progress bar.
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `visit` | [`Visit`](types.requests.md#visit) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L215) |
-| `remote` | [`Remote`](types.requests.md#remote) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L215) |
+| `visit` | [`Visit`](types.requests.md#visit) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L215) |
+| `remote` | [`Remote`](types.requests.md#remote) | [lib/index.tsx:215](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L215) |
 
 ###### Defined in
 
-[lib/index.tsx:211](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L211)
+[lib/index.tsx:211](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L211)
 
 <a id="componentdidmount" name="componentdidmount"></a>
 
@@ -93,7 +93,7 @@ Called immediately after a component is mounted. Setting state here will trigger
 
 ###### Defined in
 
-[lib/index.tsx:217](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L217)
+[lib/index.tsx:217](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L217)
 
 <a id="componentwillunmount" name="componentwillunmount"></a>
 
@@ -114,7 +114,7 @@ cancelled network requests, or cleaning up any DOM elements created in `componen
 
 ###### Defined in
 
-[lib/index.tsx:232](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L232)
+[lib/index.tsx:232](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L232)
 
 <a id="buildstore" name="buildstore"></a>
 
@@ -142,7 +142,7 @@ using Redux toolkit's `configureStore` to build the store.
 
 ###### Defined in
 
-[lib/index.tsx:248](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L248)
+[lib/index.tsx:248](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L248)
 
 <a id="createhistory" name="createhistory"></a>
 
@@ -156,7 +156,7 @@ using Redux toolkit's `configureStore` to build the store.
 
 ###### Defined in
 
-[lib/index.tsx:253](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L253)
+[lib/index.tsx:253](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L253)
 
 <a id="mapping" name="mapping"></a>
 
@@ -174,7 +174,7 @@ to render with which payload.
 
 ###### Defined in
 
-[lib/index.tsx:270](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L270)
+[lib/index.tsx:270](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L270)
 
 <a id="render" name="render"></a>
 
@@ -192,7 +192,7 @@ to render with which payload.
 
 ###### Defined in
 
-[lib/index.tsx:272](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/index.tsx#L272)
+[lib/index.tsx:272](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/index.tsx#L272)
 
 ## Variables
 
@@ -204,7 +204,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:1](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L1)
+[lib/actions.ts:1](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L1)
 
 ***
 
@@ -216,7 +216,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:2](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L2)
+[lib/actions.ts:2](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L2)
 
 ***
 
@@ -228,7 +228,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:3](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L3)
+[lib/actions.ts:3](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L3)
 
 ***
 
@@ -240,7 +240,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:5](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L5)
+[lib/actions.ts:5](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L5)
 
 ***
 
@@ -252,7 +252,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:9](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L9)
+[lib/actions.ts:9](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L9)
 
 ***
 
@@ -264,7 +264,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:10](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L10)
+[lib/actions.ts:10](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L10)
 
 ***
 
@@ -276,7 +276,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:12](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L12)
+[lib/actions.ts:12](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L12)
 
 ***
 
@@ -288,7 +288,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:14](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L14)
+[lib/actions.ts:14](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L14)
 
 ***
 
@@ -300,7 +300,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:15](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L15)
+[lib/actions.ts:15](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L15)
 
 ***
 
@@ -312,7 +312,7 @@ to render with which payload.
 
 #### Defined in
 
-[lib/actions.ts:16](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/actions.ts#L16)
+[lib/actions.ts:16](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/actions.ts#L16)
 
 ## Functions
 
@@ -358,7 +358,7 @@ A middleware that will update all Fragment across the AllPages slice, if a fragm
 
 #### Defined in
 
-[lib/middleware.ts:15](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/middleware.ts#L15)
+[lib/middleware.ts:15](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/middleware.ts#L15)
 
 ***
 
@@ -383,7 +383,7 @@ Retrieves data from a JSON object using a [Keypath](types.md#keypath-2)
 
 #### Defined in
 
-[lib/utils/immutability.ts:22](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/utils/immutability.ts#L22)
+[lib/utils/immutability.ts:22](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/utils/immutability.ts#L22)
 
 ***
 
@@ -407,4 +407,4 @@ Converts a url to a PageKey.
 
 #### Defined in
 
-[lib/utils/url.ts:57](https://github.com/thoughtbot/superglue/blob/f53c3d598dcedc7b859473062831c9c31367097a/superglue/lib/utils/url.ts#L57)
+[lib/utils/url.ts:57](https://github.com/thoughtbot/superglue/blob/be017596661ef6ab66e199643ed384e7715f12ba/superglue/lib/utils/url.ts#L57)