From 7b7e49ba6d74fa029cc4257926501a7cb1763091 Mon Sep 17 00:00:00 2001 From: Parth Agrawal Date: Wed, 4 Sep 2024 13:28:45 -0400 Subject: [PATCH 1/2] update quickstart code and fix link to SDK reference --- docs/getting-started/quickstart.mdx | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx index 0c72def..d6e9907 100644 --- a/docs/getting-started/quickstart.mdx +++ b/docs/getting-started/quickstart.mdx @@ -55,7 +55,7 @@ app = client.apps.get_or_create( ``` ```javascript NodeJS -const app = await honcho.apps.getOrCreate({ name: 'string' }); +const app = await honcho.apps.getOrCreate("Example"); ``` @@ -71,7 +71,7 @@ user = honcho.apps.users.create(app_id=app.id, name="User") ``` ```javascript NodeJS -const user = honcho.apps.users.create(app.id, {name: "User" }) +const user = await honcho.apps.users.create(app.id, { name: "User" }); ``` @@ -85,7 +85,9 @@ session = client.apps.users.sessions.create(user.id, app.id, location_id=default ``` ```javascript NodeJS -const session = client.apps.users.sessions.create(app.id, user.id, { location_id: "default"}) -> Session +const session = await honcho.apps.users.sessions.create(app.id, user.id, { + metadata: { location_id: "default" }, +}); ``` @@ -99,7 +101,10 @@ client.apps.users.sessions.messages.create(session.id, app.id, user.id, content= ``` ```javascript NodeJS -client.apps.users.sessions.messages.create(app.id, user.id, session.id, { content: "Test", is_user: true }) +honcho.apps.users.sessions.messages.create(app.id, user.id, session.id, { + content: "Test", + is_user: true, +}); ``` @@ -124,4 +129,7 @@ for await (const session of honcho.apps.users.sessions.list(app.id, user.id)) { This is a super simple overview of how to get up and running with the Honcho SDK. We covered the basic methods for reading and writing from the hosted storage service. Next, we'll cover alternative forms of hosting Honcho. -For a more detailed look at the SDK check out the SDK reference [here](https://api.python.honcho.dev/). \ No newline at end of file +For a more detailed look at the SDK, check out the SDK references: + +- [Honcho Python SDK](https://github.com/plastic-labs/honcho-python/blob/main/api.md) +- [Honcho NodeJS SDK](https://github.com/plastic-labs/honcho-node/blob/main/api.md) From 64049d94d1812b12131d30fa198608be42ade987 Mon Sep 17 00:00:00 2001 From: Parth Agrawal Date: Wed, 4 Sep 2024 14:23:22 -0400 Subject: [PATCH 2/2] add sdk references to sidebar --- docs/mint.json | 7 +++++++ docs/sdk-reference/nodejs-sdk.mdx | 4 ++++ docs/sdk-reference/python-sdk.mdx | 4 ++++ 3 files changed, 15 insertions(+) create mode 100644 docs/sdk-reference/nodejs-sdk.mdx create mode 100644 docs/sdk-reference/python-sdk.mdx diff --git a/docs/mint.json b/docs/mint.json index 329110d..8f243cf 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -50,6 +50,13 @@ "getting-started/architecture" ] }, + { + "group": "SDK Reference", + "pages": [ + "sdk-reference/python-sdk", + "sdk-reference/nodejs-sdk" + ] + }, { "group": "Contributing", "pages": [ diff --git a/docs/sdk-reference/nodejs-sdk.mdx b/docs/sdk-reference/nodejs-sdk.mdx new file mode 100644 index 0000000..c258f96 --- /dev/null +++ b/docs/sdk-reference/nodejs-sdk.mdx @@ -0,0 +1,4 @@ +--- +title: "NodeJS SDK" +url: "https://github.com/plastic-labs/honcho-node/blob/main/api.md" +--- diff --git a/docs/sdk-reference/python-sdk.mdx b/docs/sdk-reference/python-sdk.mdx new file mode 100644 index 0000000..f640867 --- /dev/null +++ b/docs/sdk-reference/python-sdk.mdx @@ -0,0 +1,4 @@ +--- +title: "Python SDK" +url: "https://github.com/plastic-labs/honcho-python/blob/main/api.md" +---