Updates SDK docs, switches default branch in instructions to develop

TrueBlocks · May 28, 2024 · 47783ae · 47783ae
1 parent 9646d04
commit 47783ae
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 10 deletions.
diff --git a/content/docs/install/install-core.md b/content/docs/install/install-core.md
@@ -34,10 +34,10 @@ If you need help with a particular step, see the [installation's troubleshooting
 - Clone the repo and compile the executable:
 
 ```shell
-git clone --depth 1 --recurse-submodules --branch develop https://github.com/TrueBlocks/trueblocks-core
+git clone --depth 1 --no-single-branch --recurse-submodules --branch develop https://github.com/TrueBlocks/trueblocks-core
 cd trueblocks-core
 mkdir build && cd build
-../scripts/go-work-sync.sh  # if on develop branch
+../scripts/go-work-sync.sh
 cmake ../src
 make
 ```

diff --git a/content/sdks/go.md b/content/sdks/go.md
@@ -0,0 +1,14 @@
+---
+title: "GoLang SDK"
+description: "We've generated a few SDKs for your use"
+lead: ""
+draft: false
+url: "/sdks/typescript-go"
+menu: 
+  sdks:
+    parent: langauges
+weight: 2000
+toc: true
+---
+
+The GoLang SDK is pre-alpha. There is no documentation other than the code.
diff --git a/content/sdks/introduction.md b/content/sdks/introduction.md
@@ -11,11 +11,20 @@ weight: 1000
 toc: true
 ---
 
-The [chifra serve](/chifra/admin/#chifra-daemon) command provides an API interface to `chifra`. As part of this functionality, we've
-started writing SDKs to make using the API easier. There are two SDKs so far, both in their earliest stages.
+[Chifra serve](/chifra/admin/#chifra-daemon) provides an API interface to the `chifra` command line. As part of this
+functionality, we've written two SDKs for Python and TypeScript to make using the API easier. We welcome
+contributions for other SDKs.
 
-The two SDKs are the [TypeScript SDK](/sdks/typescript-sdk/) and the [Python SDK](/sdks/python-sdk/).
+The GoLang SDK is different. Unlike the other SDKs, the GoLang SDK does not require you to run the API server.
+This has very significant performance implications because there is no serialization of the data. In the
+server case, the code must read the data from the RPC (or the local binary cache), turn it into a JSON string,
+and send it to the TypeScript or Python SDK. 
 
-We welcome PRs supporting other languages -- particularly GoLang or Rust.
+In the GoLang SDK, the data is in memory ready for use directly from disc. No strinification. This makes the
+GoLang SDK as fast as it can possbily be.
+
+The two API-releated SDKs are the [TypeScript SDK](/sdks/typescript-sdk/) and the [Python SDK](/sdks/python-sdk/).
+
+The GoLang SDKs is here [GoLang SDK](/sdks/go-sdk/).
 
 Here's the [SDKs repo](https://github.com/TrueBlocks/trueblocks-core/blob/master/sdk/README.md).
diff --git a/content/sdks/python.md b/content/sdks/python.md
@@ -7,10 +7,12 @@ url: "/sdks/python-sdk"
 menu: 
   sdks:
     parent: langauges
-weight: 3000
+weight: 4000
 toc: true
 ---
 
 Here's a link to the [Python SDK](https://github.com/TrueBlocks/trueblocks-core/blob/master/sdk/python).
 
 **Warning:** It's in its very early stage.
+
+*Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*
diff --git a/content/sdks/typescript.md b/content/sdks/typescript.md
@@ -7,10 +7,10 @@ url: "/sdks/typescript-sdk"
 menu: 
   sdks:
     parent: langauges
-weight: 2000
+weight: 3000
 toc: true
 ---
 
-Here's a link to the [TypeScript SDK](https://github.com/TrueBlocks/trueblocks-core/blob/master/sdk/typescript).
+The [TypeScript SDK](https://github.com/TrueBlocks/trueblocks-core/blob/master/sdk/typescript) is pre-alpha. There is no documentation other than the code.
 
-**Warning:** It's in its very early stage.
+*Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*