build docs (#311)

holochain · Dec 17, 2024 · dcd3e25 · dcd3e25
1 parent 5938187
commit dcd3e25
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 36 deletions.
diff --git a/docs/client.chainop.md b/docs/client.chainop.md
@@ -9,28 +9,32 @@
 
 ```typescript
 export type ChainOp = {
-    [DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
+    [ChainOpType.StoreRecord]: [Signature, Action, Entry | undefined];
 } | {
-    [DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry];
+    [ChainOpType.StoreEntry]: [Signature, NewEntryAction, Entry];
 } | {
-    [DhtOpType.RegisterAgentActivity]: [Signature, Action];
+    [ChainOpType.RegisterAgentActivity]: [Signature, Action];
 } | {
-    [DhtOpType.RegisterUpdatedContent]: [
+    [ChainOpType.RegisterUpdatedContent]: [
         Signature,
         Update,
         Entry | undefined
     ];
 } | {
-    [DhtOpType.RegisterUpdatedRecord]: [Signature, Update, Entry | undefined];
+    [ChainOpType.RegisterUpdatedRecord]: [
+        Signature,
+        Update,
+        Entry | undefined
+    ];
 } | {
-    [DhtOpType.RegisterDeletedBy]: [Signature, Delete];
+    [ChainOpType.RegisterDeletedBy]: [Signature, Delete];
 } | {
-    [DhtOpType.RegisterDeletedEntryAction]: [Signature, Delete];
+    [ChainOpType.RegisterDeletedEntryAction]: [Signature, Delete];
 } | {
-    [DhtOpType.RegisterAddLink]: [Signature, CreateLink];
+    [ChainOpType.RegisterAddLink]: [Signature, CreateLink];
 } | {
-    [DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink];
+    [ChainOpType.RegisterRemoveLink]: [Signature, DeleteLink];
 };
 ```
-**References:** [DhtOpType.StoreRecord](./client.dhtoptype.md)<!-- -->, [Signature](./client.signature.md)<!-- -->, [Action](./client.action.md)<!-- -->, [Entry](./client.entry.md)<!-- -->, [DhtOpType.StoreEntry](./client.dhtoptype.md)<!-- -->, [NewEntryAction](./client.newentryaction.md)<!-- -->, [DhtOpType.RegisterAgentActivity](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterUpdatedContent](./client.dhtoptype.md)<!-- -->, [Update](./client.update.md)<!-- -->, [DhtOpType.RegisterUpdatedRecord](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterDeletedBy](./client.dhtoptype.md)<!-- -->, [Delete](./client.delete.md)<!-- -->, [DhtOpType.RegisterDeletedEntryAction](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterAddLink](./client.dhtoptype.md)<!-- -->, [CreateLink](./client.createlink.md)<!-- -->, [DhtOpType.RegisterRemoveLink](./client.dhtoptype.md)<!-- -->, [DeleteLink](./client.deletelink.md)
+**References:** [ChainOpType.StoreRecord](./client.chainoptype.md)<!-- -->, [Signature](./client.signature.md)<!-- -->, [Action](./client.action.md)<!-- -->, [Entry](./client.entry.md)<!-- -->, [ChainOpType.StoreEntry](./client.chainoptype.md)<!-- -->, [NewEntryAction](./client.newentryaction.md)<!-- -->, [ChainOpType.RegisterAgentActivity](./client.chainoptype.md)<!-- -->, [ChainOpType.RegisterUpdatedContent](./client.chainoptype.md)<!-- -->, [Update](./client.update.md)<!-- -->, [ChainOpType.RegisterUpdatedRecord](./client.chainoptype.md)<!-- -->, [ChainOpType.RegisterDeletedBy](./client.chainoptype.md)<!-- -->, [Delete](./client.delete.md)<!-- -->, [ChainOpType.RegisterDeletedEntryAction](./client.chainoptype.md)<!-- -->, [ChainOpType.RegisterAddLink](./client.chainoptype.md)<!-- -->, [CreateLink](./client.createlink.md)<!-- -->, [ChainOpType.RegisterRemoveLink](./client.chainoptype.md)<!-- -->, [DeleteLink](./client.deletelink.md)
 
diff --git a/docs/client.dhtoptype.md → docs/client.chainoptype.md b/docs/client.dhtoptype.md → docs/client.chainoptype.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [DhtOpType](./client.dhtoptype.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ChainOpType](./client.chainoptype.md)
 
-## DhtOpType enum
+## ChainOpType enum
 
 
 **Signature:**
 
 ```typescript
-export declare enum DhtOpType 
+export declare enum ChainOpType 
 ```
 
 ## Enumeration Members

diff --git a/docs/client.getdhtopaction.md → docs/client.getchainopaction.md b/docs/client.getdhtopaction.md → docs/client.getchainopaction.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpAction](./client.getdhtopaction.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getChainOpAction](./client.getchainopaction.md)
 
-## getDhtOpAction() function
+## getChainOpAction() function
 
 
 **Signature:**
 
 ```typescript
-export declare function getDhtOpAction(op: DhtOp): Action;
+export declare function getChainOpAction(op: ChainOp): Action;
 ```
 
 ## Parameters
@@ -36,7 +36,7 @@ op
 
 </td><td>
 
-[DhtOp](./client.dhtop.md)
+[ChainOp](./client.chainop.md)
 
 
 </td><td>

diff --git a/docs/client.getdhtopentry.md → docs/client.getchainopentry.md b/docs/client.getdhtopentry.md → docs/client.getchainopentry.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpEntry](./client.getdhtopentry.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getChainOpEntry](./client.getchainopentry.md)
 
-## getDhtOpEntry() function
+## getChainOpEntry() function
 
 
 **Signature:**
 
 ```typescript
-export declare function getDhtOpEntry(op: DhtOp): Entry | undefined;
+export declare function getChainOpEntry(op: ChainOp): Entry | undefined;
 ```
 
 ## Parameters
@@ -36,7 +36,7 @@ op
 
 </td><td>
 
-[DhtOp](./client.dhtop.md)
+[ChainOp](./client.chainop.md)
 
 
 </td><td>

diff --git a/docs/client.getdhtopsignature.md → docs/client.getchainopsignature.md b/docs/client.getdhtopsignature.md → docs/client.getchainopsignature.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpSignature](./client.getdhtopsignature.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getChainOpSignature](./client.getchainopsignature.md)
 
-## getDhtOpSignature() function
+## getChainOpSignature() function
 
 
 **Signature:**
 
 ```typescript
-export declare function getDhtOpSignature(op: DhtOp): Signature;
+export declare function getChainOpSignature(op: ChainOp): Signature;
 ```
 
 ## Parameters
@@ -36,7 +36,7 @@ op
 
 </td><td>
 
-[DhtOp](./client.dhtop.md)
+[ChainOp](./client.chainop.md)
 
 
 </td><td>

diff --git a/docs/client.getdhtoptype.md → docs/client.getchainoptype.md b/docs/client.getdhtoptype.md → docs/client.getchainoptype.md
@@ -1,14 +1,14 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getDhtOpType](./client.getdhtoptype.md)
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [getChainOpType](./client.getchainoptype.md)
 
-## getDhtOpType() function
+## getChainOpType() function
 
 
 **Signature:**
 
 ```typescript
-export declare function getDhtOpType(op: DhtOp): DhtOpType;
+export declare function getChainOpType(op: ChainOp): ChainOpType;
 ```
 
 ## Parameters
@@ -36,7 +36,7 @@ op
 
 </td><td>
 
-[DhtOp](./client.dhtop.md)
+[ChainOp](./client.chainop.md)
 
 
 </td><td>
@@ -46,5 +46,5 @@ op
 </tbody></table>
 **Returns:**
 
-[DhtOpType](./client.dhtoptype.md)
+[ChainOpType](./client.chainoptype.md)
 
diff --git a/docs/client.md b/docs/client.md
@@ -143,7 +143,7 @@ Description
 </td></tr>
 <tr><td>
 
-[CountersigningSessionStateType](./client.countersigningsessionstatetype.md)
+[ChainOpType](./client.chainoptype.md)
 
 
 </td><td>
@@ -153,7 +153,7 @@ Description
 </td></tr>
 <tr><td>
 
-[DhtOpType](./client.dhtoptype.md)
+[CountersigningSessionStateType](./client.countersigningsessionstatetype.md)
 
 
 </td><td>
@@ -313,7 +313,7 @@ Parse a clone id and get the role name part of it.
 </td></tr>
 <tr><td>
 
-[getDhtOpAction(op)](./client.getdhtopaction.md)
+[getChainOpAction(op)](./client.getchainopaction.md)
 
 
 </td><td>
@@ -323,7 +323,7 @@ Parse a clone id and get the role name part of it.
 </td></tr>
 <tr><td>
 
-[getDhtOpEntry(op)](./client.getdhtopentry.md)
+[getChainOpEntry(op)](./client.getchainopentry.md)
 
 
 </td><td>
@@ -333,7 +333,7 @@ Parse a clone id and get the role name part of it.
 </td></tr>
 <tr><td>
 
-[getDhtOpSignature(op)](./client.getdhtopsignature.md)
+[getChainOpSignature(op)](./client.getchainopsignature.md)
 
 
 </td><td>
@@ -343,7 +343,7 @@ Parse a clone id and get the role name part of it.
 </td></tr>
 <tr><td>
 
-[getDhtOpType(op)](./client.getdhtoptype.md)
+[getChainOpType(op)](./client.getchainoptype.md)
 
 
 </td><td>