docs: update docs & changelog

holochain · May 21, 2024 · 7382a9f · 7382a9f
1 parent dd07c24
commit 7382a9f
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,14 +5,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## \[Unreleased\]
 
 ### Added
-- Test for Rust enum serialization.
 ### Changed
-- **BREAKING** Update enum serialization to match [changed Conductor API serialization format](https://github.com/holochain/holochain/blob/develop/crates/holochain/CHANGELOG.md#040-dev1).
 ### Fixed
 ### Removed
 
+## 2024-05-21: v0.17.0-rc.0
+### Added
+- Test for Rust enum serialization.
+### Changed
+- **BREAKING** Update enum serialization to match [changed Conductor API serialization format](https://github.com/holochain/holochain/blob/develop/crates/holochain/CHANGELOG.md#040-dev1).
+
 ## 2024-04-27: v0.17.0-dev.12
-### Fixed
+### Fixed`
 - Invalid module references which caused the client to fail to import in Node environments.
 
 ## 2024-04-26: v0.17.0-dev.11

diff --git a/docs/client.addagentinforesponse.md b/docs/client.addagentinforesponse.md
@@ -8,5 +8,5 @@
 **Signature:**
 
 ```typescript
-export type AddAgentInfoResponse = any;
+export type AddAgentInfoResponse = unknown;
 ```
diff --git a/docs/client.appstatusfilter.md b/docs/client.appstatusfilter.md
@@ -36,7 +36,7 @@ Disabled
 
 </td><td>
 
-`"disabled"`
+`"Disabled"`
 
 
 </td><td>
@@ -50,7 +50,7 @@ Enabled
 
 </td><td>
 
-`"enabled"`
+`"Enabled"`
 
 
 </td><td>
@@ -64,7 +64,7 @@ Paused
 
 </td><td>
 
-`"paused"`
+`"Paused"`
 
 
 </td><td>
@@ -78,7 +78,7 @@ Running
 
 </td><td>
 
-`"running"`
+`"Running"`
 
 
 </td><td>
@@ -92,7 +92,7 @@ Stopped
 
 </td><td>
 
-`"stopped"`
+`"Stopped"`
 
 
 </td><td>

diff --git a/docs/client.capaccess.md b/docs/client.capaccess.md
@@ -8,9 +8,7 @@
 **Signature:**
 
 ```typescript
-export type CapAccess = {
-    [CapAccessType.Unrestricted]: null;
-} | {
+export type CapAccess = [CapAccessType.Unrestricted] | {
     [CapAccessType.Transferable]: {
         secret: CapSecret;
     };

diff --git a/docs/client.deactivationreason.md b/docs/client.deactivationreason.md
@@ -8,11 +8,7 @@
 **Signature:**
 
 ```typescript
-export type DeactivationReason = {
-    never_activated: null;
-} | {
-    normal: null;
-} | {
+export type DeactivationReason = "never_activated" | "normal" | {
     quarantined: {
         error: string;
     };

diff --git a/docs/client.disabledappreason.md b/docs/client.disabledappreason.md
@@ -8,11 +8,7 @@
 **Signature:**
 
 ```typescript
-export type DisabledAppReason = {
-    never_started: null;
-} | {
-    user: null;
-} | {
+export type DisabledAppReason = "never_started" | "user" | {
     error: string;
 };
 ```
diff --git a/docs/client.entryvisibility.md b/docs/client.entryvisibility.md
@@ -8,9 +8,5 @@
 **Signature:**
 
 ```typescript
-export type EntryVisibility = {
-    Public: null;
-} | {
-    Private: null;
-};
+export type EntryVisibility = "Public" | "Private";
 ```
diff --git a/docs/client.grantedfunctions.md b/docs/client.grantedfunctions.md
@@ -8,9 +8,7 @@
 **Signature:**
 
 ```typescript
-export type GrantedFunctions = {
-    [GrantedFunctionsType.All]: null;
-} | {
+export type GrantedFunctions = GrantedFunctionsType.All | {
     [GrantedFunctionsType.Listed]: [ZomeName, FunctionName][];
 };
 ```

diff --git a/docs/client.installedappinfostatus.md b/docs/client.installedappinfostatus.md
@@ -16,9 +16,7 @@ export type InstalledAppInfoStatus = {
     disabled: {
         reason: DisabledAppReason;
     };
-} | {
-    running: null;
-};
+} | "running";
 ```
 **References:** [PausedAppReason](./client.pausedappreason.md)<!-- -->, [DisabledAppReason](./client.disabledappreason.md)