Skip to content

Commit a0c7e8a

Browse files
committed
added connecting identity to desktop page + minor fixes in other pages
1 parent bd601d7 commit a0c7e8a

15 files changed

+101
-35
lines changed

advanced/connect-identity.mdx

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: 'Connect Your Identity to Shinkai Desktop'
3+
description: 'Connect your identity so you can take part in the Shinkai Network and use p2p capabilities'
4+
icon: 'plug'
5+
---
6+
7+
After following [the previous documentation on registering your identity on-chain](/advanced/shinkai-identity), you should have your identity keys downloaded on your machine.
8+
9+
Now we will move forward with connecting this identity, using the keys, to your Shinkai node (Shinkai Desktop).
10+
11+
<Note>
12+
### Requirements
13+
14+
Before moving forward make sure you have Shinkai Desktop installed. If you don't, please reference the [Installation and Setup Guide](/quickstart) page for instructions.
15+
16+
Also, make sure you've registered an identity on-chain following the [Registering Your Shinkai Identity](/advanced/shinkai-identity) documentation.
17+
18+
> You must follow the instructions and register an identity by clicking the link in Shinkai Desktop, not by registering an identity through the dApp directly (otherwise the correct keys from Shinkai Desktop will not be used when registering your identity).
19+
20+
</Note>
21+
22+
## How to Connect Your Identity to Shinkai Desktop
23+
24+
<Steps titleSize="h3">
25+
<Step title="Copy the Keys in your Desktop App">
26+
Open your Shinkai Desktop App > Go to `Settings` > `Public Keys`.
27+
![Public Keys](/images/public-keys.jpg)
28+
<Icon icon="copy" iconType="duotone" /> Copy your `Node Public Keys`.
29+
</Step>
30+
31+
<Step title="Paste the Keys in Your Shinkai Profile">
32+
Go to [your profile](https://shinkai-contracts.pages.dev/profile) > Click your `identity` button.
33+
![Your profile](/images/profile.jpg)
34+
35+
Click the `edit` button > <Icon icon="paste" iconType="duotone" /> Paste your `Node Public Keys` as follows:
36+
- Node Encryption Key > Encryption Public Key
37+
- Node Signature > Signature Public Key
38+
- Node address: http://127.0.0.1:9550
39+
40+
![Adding Public Keys to Shinkai Identity](/images/keys-pasted.jpg)
41+
42+
<Icon icon="floppy-disk" iconType="duotone" /> `Save` the changes.
43+
44+
</Step>
45+
46+
<Step title="Restart your Shinkai Desktop App">
47+
Restart Shinkai desktop so your identity is refreshed.
48+
</Step>
49+
50+
<Step title="Copy the name of your registered Shinkai Identity">
51+
- Open Shinkai Desktop and click on the Settings tab at the bottom left corner of the application.
52+
- Click on the Shinkai Identity input box, input your identity name, and click save. Make sure to include the `@@` prefix so your identity looks like `@@myidentity.arb-sep-shinkai`.
53+
- Once you click `save`, you will have your identity connected to Shinkai Desktop!
54+
![Shinkai Identity connected](/images/connected-identity.jpg)
55+
</Step>
56+
57+
</Steps>
58+
59+
<Icon icon="hands-clapping" iconType="duotone" /> Congratulations, **you have your identity connected to Shinkai Desktop**! Now you can take part in the Shinkai Network and use p2p capabilities.

advanced/model-install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Overview'
33
description:
4-
icon:
4+
icon: 'magnifying-glass'
55
---
66

77
## Installing Local AIs Manually

advanced/models/gemini.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,16 @@ description: 'A step-by-step guide to help you install Gemini models'
1010
Go to your [Google AI Studio dashboard](https://aistudio.google.com/app/apikey) > Click the `Get API Key` button > Select a project (Gemini API) > Create Key.
1111

1212
![Generate API Key](/images/gemini-api.jpg)
13-
Copy the key > Go to your Shinkai Desktop App
13+
<Icon icon="copy" iconType="duotone" /> Copy the key > Go to your Shinkai Desktop App
1414
</Step>
1515
<Step title="Install the model in Shinkai">
1616
Open Shinkai > Go to `AIs` > `+ Add AI` > `+ Manually Add AI`
17-
- 1. Select **Gemini** in Model Provider.
18-
- 2. Select the **Model Type** you'd like to install (i.e., `Gemini 1.5 Flash, Gemini 1.5 Pro, or Custom` for other models)
19-
- (Optional) You can edit the **AI Name** --> This is how it will be displayed in your Chats view.
17+
1. Select **Gemini** in Model Provider.
18+
2. Select the **Model Type** you'd like to install (i.e., `Gemini 1.5 Flash, Gemini 1.5 Pro, or Custom` for other models)
19+
20+
(Optional) You can edit the **AI Name** --> This is how it will be displayed in your Chats view.
2021
<Note>This field only accepts alphanumeric characters and underscores. </Note>
21-
- 3. Paste the API key you created in step 1 > `Add AI`
22+
3. <Icon icon="paste" iconType="duotone" /> Paste the API key you created in step 1 > `Add AI`
2223

2324
![Paste API key in Shinkai](/images/gemini-install.jpg)
2425
</Step>

advanced/models/gpt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ icon:
1313
Go to your [OpenAI dashboard](https://platform.openai.com/api-keys) > Select `API keys` from the side menu > Click the `+ Create new secret key` button.
1414

1515
![Generate API Key](/images/openai-api-key.jpg)
16-
Copy the key > Go to Shinkai
16+
<Icon icon="copy" iconType="duotone" /> Copy the key > Go to Shinkai Desktop
1717
</Step>
1818
<Step title="Paste your API key in Shinkai">
1919
- Select the **Model Type** you'd like to install (i.e., `GPT 4o, GPT 4o Mini, or Custom` for other models)

advanced/models/groq.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,16 @@ Integrating Groq AI models in shinkai can enable accelerated processing of AI ta
1414
Go to your [Groq's Console](hhttps://console.groq.com/keys) > Click the `Create API Key` button > Name your Key (*e.g., Shinkai*).
1515

1616
![Generate API Key](/images/groq-key.jpg)
17-
Copy the key > Go to your Shinkai Desktop App
17+
<Icon icon="copy" iconType="duotone" /> Copy the key > Go to your Shinkai Desktop App
1818
</Step>
1919
<Step title="Install the model in Shinkai">
20-
Open Shinkai > Go to `AIs` > `+ Add AI` > `+ Manually Add AI`
21-
- 1. Select **Groq** in Model Provider.
22-
- 2. Select the **Model Type** you'd like to install (i.e., Llama3 Groq 70b, or Custom` for other models)
23-
- (Optional) You can edit the **AI Name** --> This is how it will be displayed in your Chats view.
20+
Open Shinkai > Go to `AIs` > `+ Add AI` > `+ Manually Add AI`
21+
1. Select **Groq** in Model Provider.
22+
2. Select the **Model Type** you'd like to install (i.e., Llama3 Groq 70b, or Custom` for other models)
23+
24+
(Optional) You can edit the **AI Name** --> This is how it will be displayed in your Chats view.
2425
<Note>This field only accepts alphanumeric characters and underscores. </Note>
25-
- 3. Paste the API key you created in step 1 > `Add AI`
26+
3. <Icon icon="paste" iconType="duotone" /> Paste the API key you created in step 1 > `Add AI`
2627

2728
![Paste API key in Shinkai](/images/groq-ai.jpg)
2829
</Step>

advanced/models/openrouter.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,22 @@ icon:
1717

1818
![Generate key OpenRouter](/images/openrouter-key.jpg)
1919

20-
Copy the key and go to your Shinkai app > Paste the key.
20+
<Icon icon="copy" iconType="duotone" /> Copy the key and go to your Shinkai app > Paste the key.
2121
</Step>
2222
<Step title="Select the model to install">
2323
OpenRouter offers over 200 AI models to choose from. We are going to choose the **free** model: `Meta: Llama 3.2 11B`.
24-
- Copy the model id (see image)
24+
25+
<Icon icon="copy" iconType="duotone" /> Copy the model id (see image)
2526

2627
![model id](/images/model-id.jpg)
2728

2829
</Step>
2930
<Step title="Complete the manual installation in your Shinkai app">
30-
- Paste the `model id` in the `Custom Model Type` field.
31-
- In `AI Name` field you can customize how you want to see this AI displayed in your Chats.
31+
<Icon icon="paste" iconType="duotone" /> Paste the `model id` in the `Custom Model Type` field.
32+
33+
In `AI Name` field you can customize how you want to see this AI displayed in your Chats.
3234
<Note> This field only accepts alphanumeric characters and underscores. </Note>
33-
- Click `Add AI`. You are all set!
35+
Click `Add AI`. You are all set!
3436

3537
![Openrouter New AI](/images/openrouter-new-ai.jpg)
3638

advanced/shinkai-identity.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ Registering **a Shinkai identity on-chain enables you to connect Shinkai Desktop
1616

1717
## Step-by-Step Registration Process
1818

19-
<Steps>
20-
<Step titleSize="h3" title="Acquire Arbitrum Sepolia (free)">
19+
<Steps titleSize="h3" >
20+
<Step title="Acquire Arbitrum Sepolia (free)">
2121
Use the following faucet link to acquire Arbitrum Sepolia `Eth` (for gas fees), and Shinkai `KAI` tokens (for registering your identity) at no charge: https://sepolia-faucet.shinkai.com/.
2222

2323
![Export Connection](/images/sepolia.jpg)
2424
</Step>
2525

26-
<Step titleSize="h3" title="Open Shinkai Desktop">
26+
<Step title="Open Shinkai Desktop">
2727
Open Shinkai Desktop and click on the `Settings` tab at the bottom left corner of the application.
2828
</Step>
2929

30-
<Step titleSize="h3" title="Click the 'Register your Shinkai Identity' link">
30+
<Step title="Click the 'Register your Shinkai Identity' link">
3131
In `General`, under the `Shinkai identity` field, you will find the link.
3232
Once clicked, it will open the Shinkai Identity Registration webpage (with your application's keys automatically filled out for you).
3333
</Step>
3434

35-
<Step titleSize="h3" title="Connect Your Wallet">
35+
<Step title="Connect Your Wallet">
3636
On the webpage click `Connect Wallet` & **choose the one you used to receive tokens at the faucet**.
3737

3838
![Connect your wallet](/images/connect-wl.jpg)
@@ -43,20 +43,20 @@ Registering **a Shinkai identity on-chain enables you to connect Shinkai Desktop
4343
<Note> Based on the length of the name the amount of tokens required to stake will differ. **The longer the name, the less tokens you need to provide**. </Note>
4444

4545
</Step>
46-
<Step titleSize="h3" title="Download the JSON file">
46+
<Step title="Download the JSON file">
4747
Once you've entered your desired name, proceed forward to the next step, where **you will download a JSON file that backs up your application's keys** (node keys) which will be connected to your Shinkai Identity (the identity itself is tied to your wallet making everything secure/resettable).
4848
![Download the JSON File](/images/json.jpg)
4949
Proceed forward by **confirming** you've downloaded the JSON file, and you will now move forward with submitting the transaction on-chain.
5050
![Confirm Json File](/images/confirm-json.jpg)
5151

5252
</Step>
5353

54-
<Step titleSize="h3" title="Confirm Transaction">
54+
<Step title="Confirm Transaction">
5555
Your wallet will pop-up and request to `Confirm` interaction with the smart contract.
5656
Once this is done, you should see a screen to `Confirm` staking your KAI tokens to register your identity.
5757
![Confirm transaction](/images/transaction.jpg)
5858
</Step>
59-
<Step titleSize="h3" title="You Have Registered Your Identity!">
59+
<Step title="You Have Registered Your Identity!">
6060
Once the transaction confirms, **you will have officially registered your first Shinkai Identity!**
6161

6262
**Your identity is an NFT** which can be added to your wallet for easier tracking if you so desire.
@@ -65,7 +65,7 @@ Registering **a Shinkai identity on-chain enables you to connect Shinkai Desktop
6565

6666
</Steps>
6767

68-
Congratulations! With your tokens staked they will accrue inflation awards, and **your identity can now be connected to Shinkai Desktop**.
68+
<Icon icon="hands-clapping" iconType="solid" /> Congratulations! With your tokens staked they will accrue inflation awards, and **your identity can now be connected to Shinkai Desktop**.
6969

70-
Continue to the next section to learn how to connect your identity.
70+
Continue to [the next section](/advanced/connect-identity) to learn how to connect your identity.
7171

basics/ai-chats.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ When creating a new chat there are different settings you can adjust:
3838
Shinkai comes with algorithmic instructions –or workflows– ready to use, helping you optimize tasks and processes.
3939
Just click on the workflow icon and it will display the `Workflow Library` where you can select the workflow you'd like to apply in your prompt.
4040

41-
Clicking the plus icon at the top right corner will lead you to the [Playground](/advanced/workflows), where you can create custom workflows adapted to your needs.
41+
Clicking the <Icon icon="plus" iconType="duotone" /> plus icon at the top right corner will lead you to the [Playground](/advanced/workflows), where you can create custom workflows adapted to your needs.
4242
<Frame>
4343
<img src="/images/workflows.jpg" style={{ borderRadius: '0.5rem' }} />
4444
</Frame>

basics/chat-settings.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,17 @@ You can access chat settings to adjust how the model generates text. By adjustin
4949
To achieve optimal responses from an AI model, consider the following setup:
5050
<Steps>
5151
<Step title="Determine Your Goals">
52-
- For **creative tasks** (*e.g., storytelling*), use a higher temperature (around `0.8`) with moderate top-p (`0.9`) and top-k (`30`).
53-
- For **factual or structured responses** (*e.g., technical writing*), lower temperature (`0.5`) with lower top-p (`0.7`) and top-k (`20`) may be preferable.
52+
For **creative tasks** (*e.g., storytelling*), use a higher temperature (around `0.8`) with moderate top-p (`0.9`) and top-k (`30`).
53+
54+
For **factual or structured responses** (*e.g., technical writing*), lower temperature (`0.5`) with lower top-p (`0.7`) and top-k (`20`) may be preferable.
5455
</Step>
5556
<Step title="Experiment and Iterate">
56-
- Start with recommended values and adjust based on output quality.
57-
- Monitor for balance between creativity and coherence; **tweak one parameter at a time to understand its impact**.
57+
Start with recommended values and adjust based on output quality.
58+
59+
Monitor for balance between creativity and coherence; **tweak one parameter at a time to understand its impact**.
5860
</Step>
5961
<Step title="Utilize Feedback Loops">
60-
- Incorporate user feedback or evaluation metrics to refine settings further.
62+
Incorporate user feedback or evaluation metrics to refine settings further.
6163
</Step>
6264
</Steps>
6365
By carefully tuning these parameters, you can significantly enhance the performance of AI models in generating relevant, coherent, and engaging text outputs tailored to specific applications or audiences.

first-steps.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The default view when you opening Shinkai Desktop is the `Chats` view. Here you
2727
</Tab>
2828
<Tab title="2. Chats">
2929
Here's where you can access your chats. Notice there are two tabs at the top: `Active` and `Archive`.
30-
To keep your active chats view clear, you can archive each by simply hovering your cursor over the chat and clicking the 📦 box icon.
30+
To keep your active chats view clear, you can archive each by simply hovering your cursor over the chat and clicking the <Icon icon="box" iconType="duotone" /> box icon.
3131
</Tab>
3232
<Tab title="4. AI Response Field">
3333
In this section you will see the AI chat response once you have prompted it with instructions or questions.

0 commit comments

Comments
 (0)