Skip to content

Fix cleanup sidebar folders #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
7ad7efa
update image paths and refences
Abukstech Jun 24, 2025
60a06c4
fit:clean up paths
Abukstech Jun 24, 2025
35b43c0
fix all paths and routes
Abukstech Jun 24, 2025
8f82b23
added `gaianet info` entry
GhoulKingR Jun 21, 2025
e2d7214
removed "if you ever forget any" text
GhoulKingR Jun 23, 2025
04c0170
Fix: updated internal links for Docusaurus
MAYANK-MAHAUR Jun 25, 2025
5fcfc62
added dark-mode icon
GhoulKingR Jun 26, 2025
64a73e5
changed dark-mode icon to the theme's primary color shade of white
GhoulKingR Jun 26, 2025
35decb5
added docusaurus startup failure solution to readme
GhoulKingR Jun 25, 2025
726b4e1
moved troubleshooting section to contribution guide
GhoulKingR Jun 25, 2025
78862c0
Fix: Footer link hover not visible in light mode Applied theme-speci…
audu-joshua Jun 24, 2025
37fc3e0
fix(dify.md): correct typos in embedding, model, and automatically
NikolaiKryshnev Jul 1, 2025
9fedae3
fix(langchain.md): correct typos in offers and response
NikolaiKryshnev Jul 1, 2025
8383ecc
fix(dify.md): correct typos in model, embedding, and automatically
NikolaiKryshnev Jul 1, 2025
102d9a3
update image paths and refences
Abukstech Jun 24, 2025
6fef5fd
fit:clean up paths
Abukstech Jun 24, 2025
23205fc
added `gaianet info` entry
GhoulKingR Jun 21, 2025
d552f9a
removed "if you ever forget any" text
GhoulKingR Jun 23, 2025
db77507
update image paths and refences
Abukstech Jun 24, 2025
d6d3c3b
fit:clean up paths
Abukstech Jun 24, 2025
ff95c58
added `gaianet info` entry
GhoulKingR Jun 21, 2025
29d7c48
removed "if you ever forget any" text
GhoulKingR Jun 23, 2025
2416334
update image paths and refences
Abukstech Jun 24, 2025
d0ae690
fit:clean up paths
Abukstech Jun 24, 2025
5d19980
fix conflicting files
Abukstech Jul 1, 2025
8d634d7
fix this auth file
Abukstech Jul 1, 2025
f233634
added docusaurus startup failure solution to readme
GhoulKingR Jun 25, 2025
1590616
moved troubleshooting section to contribution guide
GhoulKingR Jun 25, 2025
4e63030
added docusaurus startup failure solution to readme
GhoulKingR Jun 25, 2025
30b54c7
moved troubleshooting section to contribution guide
GhoulKingR Jun 25, 2025
5c5a1a3
added docusaurus startup failure solution to readme
GhoulKingR Jun 25, 2025
7d64bd8
moved troubleshooting section to contribution guide
GhoulKingR Jun 25, 2025
96a91f1
added `gaianet info` entry
GhoulKingR Jun 21, 2025
008e01d
removed "if you ever forget any" text
GhoulKingR Jun 23, 2025
c859a62
added docusaurus startup failure solution to readme
GhoulKingR Jun 25, 2025
af1641d
moved troubleshooting section to contribution guide
GhoulKingR Jun 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,55 @@ Visit `http://localhost:3000` to preview your changes.

---

## Troubleshooting

### Command failed: ps cax -o command...

While running `npm start` you may run into a this error. This happens because of a bug that prevents docusaurus from starting on macOS computers without a Chrome/Chromium browser installed (or haven't opened one in a while). To fix this error, you can either run the update command in the error message or open a Chrome/Chromium tab.

#### Error details

```
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Update available 3.8.0 → 3.8.1

To upgrade Docusaurus packages with the latest version, run the following command:
`npm i @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-analytics@latest @docusaurus/plugin-google-tag-manager@latest @docusaurus/preset-classic@latest
@docusaurus/module-type-aliases@latest @docusaurus/types@latest`

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/

● Client █████████████████████████ building (10%) 0/3 entries 2/3 dependencies 0/2 modules 1 active
node_modules/webpack-dev-server/client/index.js


[ERROR] Error: Command failed: ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"

at genericNodeError (node:internal/errors:983:15)
at wrappedFn (node:internal/errors:537:14)
at ChildProcess.exithandler (node:child_process:414:12)
at ChildProcess.emit (node:events:518:28)
at maybeClose (node:internal/child_process:1101:16)
at Socket.<anonymous> (node:internal/child_process:456:11)
at Socket.emit (node:events:518:28)
at Pipe.<anonymous> (node:net:351:12) {
code: 1,
killed: false,
signal: null,
cmd: 'ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"',
stdout: '',
stderr: ''
}
[INFO] Docusaurus version: 3.8.0
Node version: v22.16.0
```

---

## Docs Structure Overview

- `docs/` – Markdown files for core documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ It is designed to be dynamic, organically growing, and learning as users use it.

You will need a Gaia node to provide LLM services to the agent app. You can

* [run your own node](../../getting-started/quick-start)
* [use a public node](../nodes)
* [run your own node](../../getting-started/quick-start/quick-start.md)
* [use a public node](../../nodes/nodes.md)

In this tutorial, we will use the public [Llama-3.1-8B node](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.1-8b-instruct) to power the Agent Zero.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ CodeGPT is a pair-programming partner for developers. It offers AI chat assistan

You will need a Gaia node ready to provide LLM services through a public URL. You can

* [run your own node](../../getting-started/quick-start)
* [use a public node](../nodes)
* [run your own node](../../getting-started/quick-start/quick-start.md)
* [use a public node](../../nodes/nodes.md)

In this tutorial, we will use the public CodeStral nodes to power the CodeGPT plugin.

Expand Down Expand Up @@ -49,7 +49,7 @@ Click the CODEGPT on the right sidebar and enter the settings page for CodeGPT.

Save the above settings.

> If you're using a Domain service, not your own node, you will [need to get an API key from Gaia](../getting-started/authentication.md).
> If you're using a Domain service, not your own node, you will [need to get an API key from Gaia](/docs/getting-started/authentication/authentication.md).

## Use the plugin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,16 @@ Leave the API Key field empty.
![Configure a Gaia Llama3 8b model in Dify](dify_chat.png)

Most Dify applications also require an embedding model to search text in the vector space.
Add an mebedding model with the modela name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../nodes).
Add an embedding model with the model name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../nodes).
Leave the API Key field empty.

![Configure a Gaia embedding model in Dify](dify_embedding.png)

That's it. You can now see that the new models are available at the top panel of Dify for every chatbot or agent. Just select your Gaia models for chat or embedding, and the Dify app will automagically use it!
That's it. You can now see that the new models are available at the top panel of Dify for every chatbot or agent. Just select your Gaia models for chat or embedding, and the Dify app will automatically use it!

![Select a Gaia node as backend model in Dify](dify_select.png)

![Chat with the Gaia Llama3 8b model in Dify](dify_chatbot_ui.png)



2 changes: 1 addition & 1 deletion docs/agent-integrations/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pip install openai
```

When you create an OpenAI client using the library, you can pass in the API endpoint point as the `base_url`.
Remember to append the `/v1` after the host name. You can find a list of public nodes [here](../nodes.md).
Remember to append the `/v1` after the host name. You can find a list of public nodes [here](../nodes/nodes.md).

```
import openai
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You will need a Gaia node ready to provide LLM services through a public URL. Yo
- [Run your own node](../../getting-started/quick-start)
- [Use a public node](../nodes)

If you are using a public node, you will need an [API key](https://www.gaianet.ai/setting/gaia-api-keys). **Gaia overs free 50,000 API credits to use with available services such as public nodes when you apply for a developer account**.
If you are using a public node, you will need an [API key](https://www.gaianet.ai/setting/gaia-api-keys). **Gaia offers free 50,000 API credits to use with available services such as public nodes when you apply for a developer account**.

### Setup

Expand Down Expand Up @@ -91,7 +91,7 @@ Integrations with Langchain and Gaia can be done with any JavaScript or Python.
base_url="gaia-node-url/v1"
)

reponse = model.invoke("Hello, world!")
response = model.invoke("Hello, world!")

print(response)
```
Expand Down Expand Up @@ -125,4 +125,4 @@ Once you have the basic connection established, you can start using Langchain's
</TabItem>
</Tabs>

The LangChain support also opens up integrations with [LangGraph](https://www.langchain.com/langgraph) and [LangSmith](https://www.langchain.com/langsmith).
The LangChain support also opens up integrations with [LangGraph](https://www.langchain.com/langgraph) and [LangSmith](https://www.langchain.com/langsmith).
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ Collecting usage statistics. To deactivate, set browser.gatherUsageStats to fals

Finally, you can open the `http://localhost:8501` in your browser to generate a book.

![](book-01.png)
![](../book/book-01.png)

The LlamaEdgeBook will first generate an outline based on your prompt, and then create the chapter content based on the outline.

![](book-02.png)
![](../book/book-02.png)

You can also download the book after the generation is complete.

![](book-03.png)
![](../book/book-03.png)
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ gaianet start
The node is ready when it shows `The Gaia node is started at: https://...` on the console.
You can go to that URL from your browser to interact with the Gaia node.

You can [customize your Gaia node](../customize.md) with your own choice of LLMs and knowledge base snapshots.
You can [customize your Gaia node](../../customize/customize.md) with your own choice of LLMs and knowledge base snapshots.

## Running a CPU-only AWS instance

Expand All @@ -70,4 +70,4 @@ gaianet start
The node is ready when it shows `The Gaia node is started at: https://...` on the console.
You can go to that URL from your browser to interact with the Gaia node.

You can [customize your Gaia node](../customize.md) with your own choice of LLMs and knowledge base snapshots.
You can [customize your Gaia node](../../customize/customize.md) with your own choice of LLMs and knowledge base snapshots.
18 changes: 9 additions & 9 deletions docs/getting-started/advanced-deployment-options/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ wsl --install Ubuntu-24.04

Following is the progress that you should notice when WSL and Ubuntu-24.04 is being installed.

![](wsl-install-ubuntu.png)
![](wsl-installer.png)
![](launching-ubuntu.png)
![](installation-complete.png)
![](./wsl-ubuntu/wsl-install-ubuntu.png)
![](./wsl-ubuntu/wsl-installer.png)
![](./wsl-ubuntu/launching-ubuntu.png)
![](./wsl-ubuntu/installation-complete.png)

## Step 2

Expand All @@ -37,15 +37,15 @@ Make sure to:

Once WSL is installed and your choice of Ubuntu is installed, you should see the following:

![Ubuntu-24.04 Installation Complete](installation-complete.png)
![Ubuntu-24.04 Installation Complete](./wsl-ubuntu/installation-complete.png)

## Step 3

Once you see the user account logged in as shown in the above screenshot, you can follow the Gaia CLI installation steps from [here](https://docs.gaianet.ai/getting-started/quick-start/#installing-the-node).

![Gaia CLI Installation](gaia-cli-installation.png)
![Gaia CLI Installation Complete](cli-installation.png)
![Gaianet Init](gaianet-init.png)
![Gaianet Start](gaianet-start.png)
![Gaia CLI Installation](./gaia/gaia-cli-installation.png)
![Gaia CLI Installation Complete](./cli/cli-installation.png)
![Gaianet Init](./gaia/gaianet-init.png)
![Gaianet Start](./gaia/gaianet-start.png)

> That's it! Gaia now runs on your Windows machine!
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ We're introducing API keys for authentication. You can create API keys by follow
2. Click **CONNECT** and connect your Metamask Wallet
3. After connecting your wallet, click on the profile drop down and then click **Setting**

![](settings-for-api.png)
![](../settings-for-api/settings-for-api.png)

4. Under **Setting**, click on **Gaia API Keys** and then **Create API Key**

![](settings-for-api-keys.png)
![](../settings-for-api/settings-for-api-keys.png)

5. Give your API Key a name and click **Create**

Expand All @@ -24,9 +24,9 @@ Remember that your API key is a secret! Do not share it with others or expose it

:::

![](create-api-key.png)
![](../api/create-api-key.png)

![](api-key-created.png)
![](../api/api-key-created.png)

:::tip Tip

Expand All @@ -40,4 +40,4 @@ Your API Key is like a password and helps verify your usage. This will be one of

Currently, we don't charge anything for usage or API key creation. However, it is highly recommended that you start using and updating your existing applications or new ones with your own API keys to avoid any disruption in the future.

Please refer to the [API Reference](../getting-started/api-reference) page for the updated examples with the API keys usage.
Please refer to the [API Reference](../api-reference.md) page for the updated examples with the API keys usage.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Subcommands:
init Initialize the GaiaNet node.
run|start Start the GaiaNet node.
stop Stop the GaiaNet node.
info Show the device_id and node_id.
Options:
--help Show this help message
Expand Down Expand Up @@ -110,6 +111,23 @@ The output is the following.
[+] COMPLETED! The config.json is updated successfully.
```

## info

You can use `gaianet info` to display the id of the current running node and device running the node.

```
gaianet info
```

Running the command gives this output:

```
Node ID: 0x1234567890abcdef0987654321fedcbabcdef123
Device ID: device-fedcbabcdef0123456789098
```


## base

The `--base` option is global. You can combine it with other subcommands to specify a base directory for the Gaia node other than the `$HOME/gaianet`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ https://0x1234...xyz.gaia.domains/

On the Gaia node dashboard, you will see a "Chat with this node" button.

![](chat_button.png)
![](../chat-button/chat_button.png)

## OpenAI API replacement

The Gaia node is a drop-in replacement for OpenAI API in [agent and LLM apps](../agent-integrations/intro).
On the Gaia node dashboard, you will see a table that shows how to replace OpenAI parameters in those apps.

![](openai_api_options.png)
![](../openai/openai_api_options.png)

Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ The Gaia node API service is fully compatible with the OpenAI JSON spec, and hen

The Gaia protocol connects and incentivizes Gaia nodes and domains to form a coherent network of web services for AI agents. It provides a mechanism to discover, connect to, and pay for Gaia node services through a decentralized marketplace. It also incentivizes domains to manage node agents through a staking program. Furthermore, the Gaia protocol connects model creators (i.e., people who have skills to finetune models) and knowledge providers to node operators through a marketplace.

![Gaia Protocol](./gaia-protocol.png)
![Gaia Protocol](../openai/openai_api_options.png)
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ gaianet start

## Next steps

- [Customize](customize.md) your node. You probably do not wish to just run the default Phi-3 model and Paris knowledge base.
- [Join the Gaia Protocol](register.md) and join the Gaia protocol network to receive payments.
- [Ensure Node Reliability](advanced-deployment-options/protect.md) the node server to ensure stable service.
- [Customize](../customize/customize.md) your node. You probably do not wish to just run the default Phi-3 model and Paris knowledge base.
- [Join the Gaia Protocol](../register/register.md) and join the Gaia protocol network to receive payments.
- [Ensure Node Reliability](../advanced-deployment-options/protect.md) the node server to ensure stable service.

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Node ID: 0x80642b1----9a76a284efeb2bb6d142e

Device ID: device-e77---1446f1b51
```
![](register-01.png)
![](../register/register-01.png)

To receive rewards, bind your node and device IDs with a Metamask account using the Gaia web portal:

Expand All @@ -27,7 +27,7 @@ To receive rewards, bind your node and device IDs with a Metamask account using
3. Hover on your profile and click **"Setting"** and click **"Nodes."**
4. Click **"Connect new node"** and enter your node and device IDs in the boxes.
5. Click **"Join"**
![](node-register.png)
![](../mynode/node-register.png)

After your node has successfully joined the network, it will be displayed in the list of nodes on the Node Page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The solution is to disable the `autoMemoryReclaim` feature in WSL. Step to turn
1. Edit `C:\Users<Your user name>.wslconfig`
2. Remove or comment out `autoMemoryReclaim` in `[experimental]` section.

![](disable_autoMemoryReclaim_wsl.png)
![](../disable-automemory/disable_autoMemoryReclaim_wsl.png)

Thanks to [RoggeOhta](https://github.com/RoggeOhta) for discovering this. You can learn more about it [here](https://github.com/GaiaNet-AI/gaianet-node/issues/46).

Expand Down Expand Up @@ -173,7 +173,7 @@ This will temporarily set the FD limit to 10,000. Next, use `gaianet init` and `

When running `curl -sSfL 'https://github.com/GaiaNet-AI/gaianet-node/releases/latest/download/install.sh' | bash` to install GaiaNet node software, you may meet the permission denied error especially installing the WasmEdge runtime.

![](troubleshooting-01.png)
![](../troubleshooting/troubleshooting-01.png)

This error is caused by the lack of `/tmp` write permission. You can use `--tmpdir` to specify where you want to install the WasmEdge runtime. Please note, you will need to have written permission to the `<YOUR_PATH>` folder.

Expand Down
18 changes: 9 additions & 9 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Gaia is a decentralized computing infrastructure that enables everyone to create
It allows individuals and businesses to create AI agents. Each Gaia node provides:

* a web-based chatbot UI [Chat with a Gaia node](https://rustcoder.gaia.domains/chatbot-ui/index.html) that is an expert on the Rust programming language.
* an OpenAI compatible API. [See how](agent-integrations/intro) to use a Gaia node as a drop-in OpenAI replacement in your favorite AI agent app.
* an OpenAI compatible API. [See how](/agent-integrations/intro) to use a Gaia node as a drop-in OpenAI replacement in your favorite AI agent app.

100% of today's AI agents are applications in the OpenAI ecosystem. With our API approach, Gaia is an alternative to OpenAI. Each Gaia node has the ability to be customized with a fine-tuned model supplemented by domain knowledge which eliminates the generic responses many have come to expect. For example, a Gaia node for a financial analyst agent can write SQL code to query SEC 10K filings to respond to user questions.

Expand All @@ -21,27 +21,27 @@ Similar Gaia nodes are organized into Gaia domains, to provide stable services b

If you are an end user of AI agent applications, you can:

* [Find a list of interesting Gaia nodes you can chat with on the web, or access via API](./nodes).
* [Use a Gaia node as the backend AI engine for your favorite AI agent apps](./agent-integrations).
* [Find a list of interesting Gaia nodes you can chat with on the web, or access via API](/nodes).
* [Use a Gaia node as the backend AI engine for your favorite AI agent apps](/agent-integrations).

### Node operators

If you are interested in running Gaia nodes, you can

* [Get started with a Gaia node](./getting-started/quick-start).
* [Customize the Gaia node with a finetuned model and custom knowledge base](./getting-started/customize).
* [Join the Gaia Protocol](./getting-started/register)
* [Get started with a Gaia node](/getting-started/quick-start).
* [Customize the Gaia node with a finetuned model and custom knowledge base](/getting-started/customize).
* [Join the Gaia Protocol](/getting-started/register)

### Domain operators

If you are a Gaia Domain Name owner, you can

* [Launch your domain](./domain-guide/quick-start.md).
* [Launch your domain](/domain-guide/quick-start)


### Creators

If you are a creator or knowledge worker interested in creating your own AI agent service, you can:

* [Create your own knowledge base](./knowledge-bases).
* [Finetune a model to "speak" like you](./tutorial/llamacpp).
* [Create your own knowledge base](/knowledge-bases).
* [Finetune a model to "speak" like you](/tutorial/llamacpp).
Loading