diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85fe10f9..3e07e8b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. (node:internal/child_process:456:11) + at Socket.emit (node:events:518:28) + at Pipe. (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 diff --git a/docs/agent-integrations/agent-zero-01.png b/docs/agent-integrations/agent-zero/agent-zero-01.png similarity index 100% rename from docs/agent-integrations/agent-zero-01.png rename to docs/agent-integrations/agent-zero/agent-zero-01.png diff --git a/docs/agent-integrations/agent-zero-02.png b/docs/agent-integrations/agent-zero/agent-zero-02.png similarity index 100% rename from docs/agent-integrations/agent-zero-02.png rename to docs/agent-integrations/agent-zero/agent-zero-02.png diff --git a/docs/agent-integrations/agent-zero-03.png b/docs/agent-integrations/agent-zero/agent-zero-03.png similarity index 100% rename from docs/agent-integrations/agent-zero-03.png rename to docs/agent-integrations/agent-zero/agent-zero-03.png diff --git a/docs/agent-integrations/agent-zero-04.png b/docs/agent-integrations/agent-zero/agent-zero-04.png similarity index 100% rename from docs/agent-integrations/agent-zero-04.png rename to docs/agent-integrations/agent-zero/agent-zero-04.png diff --git a/docs/agent-integrations/agent-zero-05.png b/docs/agent-integrations/agent-zero/agent-zero-05.png similarity index 100% rename from docs/agent-integrations/agent-zero-05.png rename to docs/agent-integrations/agent-zero/agent-zero-05.png diff --git a/docs/agent-integrations/agent-zero-06.png b/docs/agent-integrations/agent-zero/agent-zero-06.png similarity index 100% rename from docs/agent-integrations/agent-zero-06.png rename to docs/agent-integrations/agent-zero/agent-zero-06.png diff --git a/docs/agent-integrations/agent-zero-07.png b/docs/agent-integrations/agent-zero/agent-zero-07.png similarity index 100% rename from docs/agent-integrations/agent-zero-07.png rename to docs/agent-integrations/agent-zero/agent-zero-07.png diff --git a/docs/agent-integrations/agent-zero-08.png b/docs/agent-integrations/agent-zero/agent-zero-08.png similarity index 100% rename from docs/agent-integrations/agent-zero-08.png rename to docs/agent-integrations/agent-zero/agent-zero-08.png diff --git a/docs/agent-integrations/agent-zero-09.png b/docs/agent-integrations/agent-zero/agent-zero-09.png similarity index 100% rename from docs/agent-integrations/agent-zero-09.png rename to docs/agent-integrations/agent-zero/agent-zero-09.png diff --git a/docs/agent-integrations/agent-zero.md b/docs/agent-integrations/agent-zero/agent-zero.md similarity index 96% rename from docs/agent-integrations/agent-zero.md rename to docs/agent-integrations/agent-zero/agent-zero.md index b93a2672..2118793c 100644 --- a/docs/agent-integrations/agent-zero.md +++ b/docs/agent-integrations/agent-zero/agent-zero.md @@ -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. diff --git a/docs/agent-integrations/anything-llm-01.png b/docs/agent-integrations/anything-llm/anything-llm-01.png similarity index 100% rename from docs/agent-integrations/anything-llm-01.png rename to docs/agent-integrations/anything-llm/anything-llm-01.png diff --git a/docs/agent-integrations/anything-llm-02.png b/docs/agent-integrations/anything-llm/anything-llm-02.png similarity index 100% rename from docs/agent-integrations/anything-llm-02.png rename to docs/agent-integrations/anything-llm/anything-llm-02.png diff --git a/docs/agent-integrations/anything-llm-03.png b/docs/agent-integrations/anything-llm/anything-llm-03.png similarity index 100% rename from docs/agent-integrations/anything-llm-03.png rename to docs/agent-integrations/anything-llm/anything-llm-03.png diff --git a/docs/agent-integrations/anything_llm.md b/docs/agent-integrations/anything-llm/anything_llm.md similarity index 100% rename from docs/agent-integrations/anything_llm.md rename to docs/agent-integrations/anything-llm/anything_llm.md diff --git a/docs/agent-integrations/book-01.png b/docs/agent-integrations/book/book-01.png similarity index 100% rename from docs/agent-integrations/book-01.png rename to docs/agent-integrations/book/book-01.png diff --git a/docs/agent-integrations/book-02.png b/docs/agent-integrations/book/book-02.png similarity index 100% rename from docs/agent-integrations/book-02.png rename to docs/agent-integrations/book/book-02.png diff --git a/docs/agent-integrations/book-03.png b/docs/agent-integrations/book/book-03.png similarity index 100% rename from docs/agent-integrations/book-03.png rename to docs/agent-integrations/book/book-03.png diff --git a/docs/agent-integrations/codegpt-01.png b/docs/agent-integrations/codegpt/codegpt-01.png similarity index 100% rename from docs/agent-integrations/codegpt-01.png rename to docs/agent-integrations/codegpt/codegpt-01.png diff --git a/docs/agent-integrations/codegpt-02.png b/docs/agent-integrations/codegpt/codegpt-02.png similarity index 100% rename from docs/agent-integrations/codegpt-02.png rename to docs/agent-integrations/codegpt/codegpt-02.png diff --git a/docs/agent-integrations/codegpt-03.png b/docs/agent-integrations/codegpt/codegpt-03.png similarity index 100% rename from docs/agent-integrations/codegpt-03.png rename to docs/agent-integrations/codegpt/codegpt-03.png diff --git a/docs/agent-integrations/codegpt-04.png b/docs/agent-integrations/codegpt/codegpt-04.png similarity index 100% rename from docs/agent-integrations/codegpt-04.png rename to docs/agent-integrations/codegpt/codegpt-04.png diff --git a/docs/agent-integrations/codegpt.md b/docs/agent-integrations/codegpt/codegpt.md similarity index 91% rename from docs/agent-integrations/codegpt.md rename to docs/agent-integrations/codegpt/codegpt.md index d169b21e..89783a6c 100644 --- a/docs/agent-integrations/codegpt.md +++ b/docs/agent-integrations/codegpt/codegpt.md @@ -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. @@ -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 diff --git a/docs/agent-integrations/continue-01.png b/docs/agent-integrations/continue/continue-01.png similarity index 100% rename from docs/agent-integrations/continue-01.png rename to docs/agent-integrations/continue/continue-01.png diff --git a/docs/agent-integrations/continue.md b/docs/agent-integrations/continue/continue.md similarity index 100% rename from docs/agent-integrations/continue.md rename to docs/agent-integrations/continue/continue.md diff --git a/docs/agent-integrations/cursor-01.png b/docs/agent-integrations/cursor/cursor-01.png similarity index 100% rename from docs/agent-integrations/cursor-01.png rename to docs/agent-integrations/cursor/cursor-01.png diff --git a/docs/agent-integrations/cursor-02.png b/docs/agent-integrations/cursor/cursor-02.png similarity index 100% rename from docs/agent-integrations/cursor-02.png rename to docs/agent-integrations/cursor/cursor-02.png diff --git a/docs/agent-integrations/cursor.md b/docs/agent-integrations/cursor/cursor.md similarity index 100% rename from docs/agent-integrations/cursor.md rename to docs/agent-integrations/cursor/cursor.md diff --git a/docs/agent-integrations/dify.md b/docs/agent-integrations/dify/dify.md similarity index 88% rename from docs/agent-integrations/dify.md rename to docs/agent-integrations/dify/dify.md index cc1a0168..3122377c 100644 --- a/docs/agent-integrations/dify.md +++ b/docs/agent-integrations/dify/dify.md @@ -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) + + diff --git a/docs/agent-integrations/dify_chat.png b/docs/agent-integrations/dify/dify_chat.png similarity index 100% rename from docs/agent-integrations/dify_chat.png rename to docs/agent-integrations/dify/dify_chat.png diff --git a/docs/agent-integrations/dify_chatbot_ui.png b/docs/agent-integrations/dify/dify_chatbot_ui.png similarity index 100% rename from docs/agent-integrations/dify_chatbot_ui.png rename to docs/agent-integrations/dify/dify_chatbot_ui.png diff --git a/docs/agent-integrations/dify_embedding.png b/docs/agent-integrations/dify/dify_embedding.png similarity index 100% rename from docs/agent-integrations/dify_embedding.png rename to docs/agent-integrations/dify/dify_embedding.png diff --git a/docs/agent-integrations/dify_select.png b/docs/agent-integrations/dify/dify_select.png similarity index 100% rename from docs/agent-integrations/dify_select.png rename to docs/agent-integrations/dify/dify_select.png diff --git a/docs/agent-integrations/flowise-01.png b/docs/agent-integrations/flowise/flowise-01.png similarity index 100% rename from docs/agent-integrations/flowise-01.png rename to docs/agent-integrations/flowise/flowise-01.png diff --git a/docs/agent-integrations/flowise-02.png b/docs/agent-integrations/flowise/flowise-02.png similarity index 100% rename from docs/agent-integrations/flowise-02.png rename to docs/agent-integrations/flowise/flowise-02.png diff --git a/docs/agent-integrations/flowise-03.png b/docs/agent-integrations/flowise/flowise-03.png similarity index 100% rename from docs/agent-integrations/flowise-03.png rename to docs/agent-integrations/flowise/flowise-03.png diff --git a/docs/agent-integrations/flowise-04.png b/docs/agent-integrations/flowise/flowise-04.png similarity index 100% rename from docs/agent-integrations/flowise-04.png rename to docs/agent-integrations/flowise/flowise-04.png diff --git a/docs/agent-integrations/flowise-tool-01.png b/docs/agent-integrations/flowise/flowise-tool-01.png similarity index 100% rename from docs/agent-integrations/flowise-tool-01.png rename to docs/agent-integrations/flowise/flowise-tool-01.png diff --git a/docs/agent-integrations/flowise-tool-02.png b/docs/agent-integrations/flowise/flowise-tool-02.png similarity index 100% rename from docs/agent-integrations/flowise-tool-02.png rename to docs/agent-integrations/flowise/flowise-tool-02.png diff --git a/docs/agent-integrations/flowise-tool-03.png b/docs/agent-integrations/flowise/flowise-tool-03.png similarity index 100% rename from docs/agent-integrations/flowise-tool-03.png rename to docs/agent-integrations/flowise/flowise-tool-03.png diff --git a/docs/agent-integrations/flowise-tool-04.png b/docs/agent-integrations/flowise/flowise-tool-04.png similarity index 100% rename from docs/agent-integrations/flowise-tool-04.png rename to docs/agent-integrations/flowise/flowise-tool-04.png diff --git a/docs/agent-integrations/flowise-tool-05.png b/docs/agent-integrations/flowise/flowise-tool-05.png similarity index 100% rename from docs/agent-integrations/flowise-tool-05.png rename to docs/agent-integrations/flowise/flowise-tool-05.png diff --git a/docs/agent-integrations/flowise-tool-06.png b/docs/agent-integrations/flowise/flowise-tool-06.png similarity index 100% rename from docs/agent-integrations/flowise-tool-06.png rename to docs/agent-integrations/flowise/flowise-tool-06.png diff --git a/docs/agent-integrations/flowiseai-tool-call.md b/docs/agent-integrations/flowise/flowiseai-tool-call.md similarity index 100% rename from docs/agent-integrations/flowiseai-tool-call.md rename to docs/agent-integrations/flowise/flowiseai-tool-call.md diff --git a/docs/agent-integrations/flowiseai.md b/docs/agent-integrations/flowise/flowiseai.md similarity index 100% rename from docs/agent-integrations/flowiseai.md rename to docs/agent-integrations/flowise/flowiseai.md diff --git a/docs/agent-integrations/gpt-planner.md b/docs/agent-integrations/gpt-planner/gpt-planner.md similarity index 100% rename from docs/agent-integrations/gpt-planner.md rename to docs/agent-integrations/gpt-planner/gpt-planner.md diff --git a/docs/agent-integrations/intro.md b/docs/agent-integrations/intro.md index 850c7b4f..24fe36a3 100644 --- a/docs/agent-integrations/intro.md +++ b/docs/agent-integrations/intro.md @@ -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 diff --git a/docs/agent-integrations/langchain.md b/docs/agent-integrations/langchain/langchain.md similarity index 92% rename from docs/agent-integrations/langchain.md rename to docs/agent-integrations/langchain/langchain.md index 3a1680ea..f9e97e97 100644 --- a/docs/agent-integrations/langchain.md +++ b/docs/agent-integrations/langchain/langchain.md @@ -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 @@ -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) ``` @@ -125,4 +125,4 @@ Once you have the basic connection established, you can start using Langchain's -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). \ No newline at end of file diff --git a/docs/agent-integrations/llamacoder.md b/docs/agent-integrations/llama/llamacoder.md similarity index 100% rename from docs/agent-integrations/llamacoder.md rename to docs/agent-integrations/llama/llamacoder.md diff --git a/docs/agent-integrations/llamacoder.png b/docs/agent-integrations/llama/llamacoder.png similarity index 100% rename from docs/agent-integrations/llamacoder.png rename to docs/agent-integrations/llama/llamacoder.png diff --git a/docs/agent-integrations/llamaedgebook.md b/docs/agent-integrations/llama/llamaedgebook.md similarity index 95% rename from docs/agent-integrations/llamaedgebook.md rename to docs/agent-integrations/llama/llamaedgebook.md index 4d58b055..1eedb305 100644 --- a/docs/agent-integrations/llamaedgebook.md +++ b/docs/agent-integrations/llama/llamaedgebook.md @@ -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) \ No newline at end of file +![](../book/book-03.png) \ No newline at end of file diff --git a/docs/agent-integrations/llamaparse-01.png b/docs/agent-integrations/llama/llamaparse-01.png similarity index 100% rename from docs/agent-integrations/llamaparse-01.png rename to docs/agent-integrations/llama/llamaparse-01.png diff --git a/docs/agent-integrations/llamaparse.md b/docs/agent-integrations/llama/llamaparse.md similarity index 100% rename from docs/agent-integrations/llamaparse.md rename to docs/agent-integrations/llama/llamaparse.md diff --git a/docs/agent-integrations/llamatutor-01.png b/docs/agent-integrations/llama/llamatutor-01.png similarity index 100% rename from docs/agent-integrations/llamatutor-01.png rename to docs/agent-integrations/llama/llamatutor-01.png diff --git a/docs/agent-integrations/llamatutor.md b/docs/agent-integrations/llama/llamatutor.md similarity index 100% rename from docs/agent-integrations/llamatutor.md rename to docs/agent-integrations/llama/llamatutor.md diff --git a/docs/agent-integrations/lobechat-gaianet-01.png b/docs/agent-integrations/lobechat/lobechat-gaianet-01.png similarity index 100% rename from docs/agent-integrations/lobechat-gaianet-01.png rename to docs/agent-integrations/lobechat/lobechat-gaianet-01.png diff --git a/docs/agent-integrations/lobechat-gaianet-02.png b/docs/agent-integrations/lobechat/lobechat-gaianet-02.png similarity index 100% rename from docs/agent-integrations/lobechat-gaianet-02.png rename to docs/agent-integrations/lobechat/lobechat-gaianet-02.png diff --git a/docs/agent-integrations/lobechat.md b/docs/agent-integrations/lobechat/lobechat.md similarity index 100% rename from docs/agent-integrations/lobechat.md rename to docs/agent-integrations/lobechat/lobechat.md diff --git a/docs/agent-integrations/obsidian-configure.png b/docs/agent-integrations/obsidian/obsidian-configure.png similarity index 100% rename from docs/agent-integrations/obsidian-configure.png rename to docs/agent-integrations/obsidian/obsidian-configure.png diff --git a/docs/agent-integrations/obsidian-enable.png b/docs/agent-integrations/obsidian/obsidian-enable.png similarity index 100% rename from docs/agent-integrations/obsidian-enable.png rename to docs/agent-integrations/obsidian/obsidian-enable.png diff --git a/docs/agent-integrations/obsidian-extract.png b/docs/agent-integrations/obsidian/obsidian-extract.png similarity index 100% rename from docs/agent-integrations/obsidian-extract.png rename to docs/agent-integrations/obsidian/obsidian-extract.png diff --git a/docs/agent-integrations/obsidian-grammar.png b/docs/agent-integrations/obsidian/obsidian-grammar.png similarity index 100% rename from docs/agent-integrations/obsidian-grammar.png rename to docs/agent-integrations/obsidian/obsidian-grammar.png diff --git a/docs/agent-integrations/obsidian-hotkey.png b/docs/agent-integrations/obsidian/obsidian-hotkey.png similarity index 100% rename from docs/agent-integrations/obsidian-hotkey.png rename to docs/agent-integrations/obsidian/obsidian-hotkey.png diff --git a/docs/agent-integrations/obsidian-model.png b/docs/agent-integrations/obsidian/obsidian-model.png similarity index 100% rename from docs/agent-integrations/obsidian-model.png rename to docs/agent-integrations/obsidian/obsidian-model.png diff --git a/docs/agent-integrations/obsidian-summarization.png b/docs/agent-integrations/obsidian/obsidian-summarization.png similarity index 100% rename from docs/agent-integrations/obsidian-summarization.png rename to docs/agent-integrations/obsidian/obsidian-summarization.png diff --git a/docs/agent-integrations/obsidian-text-continuation.png b/docs/agent-integrations/obsidian/obsidian-text-continuation.png similarity index 100% rename from docs/agent-integrations/obsidian-text-continuation.png rename to docs/agent-integrations/obsidian/obsidian-text-continuation.png diff --git a/docs/agent-integrations/obsidian.md b/docs/agent-integrations/obsidian/obsidian.md similarity index 100% rename from docs/agent-integrations/obsidian.md rename to docs/agent-integrations/obsidian/obsidian.md diff --git a/docs/agent-integrations/openwebui-01.png b/docs/agent-integrations/openwebui/openwebui-01.png similarity index 100% rename from docs/agent-integrations/openwebui-01.png rename to docs/agent-integrations/openwebui/openwebui-01.png diff --git a/docs/agent-integrations/openwebui-02.png b/docs/agent-integrations/openwebui/openwebui-02.png similarity index 100% rename from docs/agent-integrations/openwebui-02.png rename to docs/agent-integrations/openwebui/openwebui-02.png diff --git a/docs/agent-integrations/openwebui-03.png b/docs/agent-integrations/openwebui/openwebui-03.png similarity index 100% rename from docs/agent-integrations/openwebui-03.png rename to docs/agent-integrations/openwebui/openwebui-03.png diff --git a/docs/agent-integrations/openwebui-04.png b/docs/agent-integrations/openwebui/openwebui-04.png similarity index 100% rename from docs/agent-integrations/openwebui-04.png rename to docs/agent-integrations/openwebui/openwebui-04.png diff --git a/docs/agent-integrations/openwebui-05.png b/docs/agent-integrations/openwebui/openwebui-05.png similarity index 100% rename from docs/agent-integrations/openwebui-05.png rename to docs/agent-integrations/openwebui/openwebui-05.png diff --git a/docs/agent-integrations/openwebui.md b/docs/agent-integrations/openwebui/openwebui.md similarity index 100% rename from docs/agent-integrations/openwebui.md rename to docs/agent-integrations/openwebui/openwebui.md diff --git a/docs/agent-integrations/stockbot-01.png b/docs/agent-integrations/stockbot/stockbot-01.png similarity index 100% rename from docs/agent-integrations/stockbot-01.png rename to docs/agent-integrations/stockbot/stockbot-01.png diff --git a/docs/agent-integrations/stockbot.md b/docs/agent-integrations/stockbot/stockbot.md similarity index 100% rename from docs/agent-integrations/stockbot.md rename to docs/agent-integrations/stockbot/stockbot.md diff --git a/docs/agent-integrations/translation-agent.md b/docs/agent-integrations/translation-agent/translation-agent.md similarity index 100% rename from docs/agent-integrations/translation-agent.md rename to docs/agent-integrations/translation-agent/translation-agent.md diff --git a/docs/agent-integrations/zed-01.png b/docs/agent-integrations/zed/zed-01.png similarity index 100% rename from docs/agent-integrations/zed-01.png rename to docs/agent-integrations/zed/zed-01.png diff --git a/docs/agent-integrations/zed-02.png b/docs/agent-integrations/zed/zed-02.png similarity index 100% rename from docs/agent-integrations/zed-02.png rename to docs/agent-integrations/zed/zed-02.png diff --git a/docs/agent-integrations/zed-03.png b/docs/agent-integrations/zed/zed-03.png similarity index 100% rename from docs/agent-integrations/zed-03.png rename to docs/agent-integrations/zed/zed-03.png diff --git a/docs/agent-integrations/zed-04.png b/docs/agent-integrations/zed/zed-04.png similarity index 100% rename from docs/agent-integrations/zed-04.png rename to docs/agent-integrations/zed/zed-04.png diff --git a/docs/agent-integrations/zed-05.png b/docs/agent-integrations/zed/zed-05.png similarity index 100% rename from docs/agent-integrations/zed-05.png rename to docs/agent-integrations/zed/zed-05.png diff --git a/docs/agent-integrations/zed.md b/docs/agent-integrations/zed/zed.md similarity index 100% rename from docs/agent-integrations/zed.md rename to docs/agent-integrations/zed/zed.md diff --git a/docs/closed_vs_open.jpg b/docs/close_vs_open/closed_vs_open.jpg similarity index 100% rename from docs/closed_vs_open.jpg rename to docs/close_vs_open/closed_vs_open.jpg diff --git a/docs/gaianet_agent.png b/docs/gaianet/gaianet_agent.png similarity index 100% rename from docs/gaianet_agent.png rename to docs/gaianet/gaianet_agent.png diff --git a/docs/gaianet_eco.png b/docs/gaianet/gaianet_eco.png similarity index 100% rename from docs/gaianet_eco.png rename to docs/gaianet/gaianet_eco.png diff --git a/docs/gaianet_node.png b/docs/gaianet/gaianet_node.png similarity index 100% rename from docs/gaianet_node.png rename to docs/gaianet/gaianet_node.png diff --git a/docs/getting-started/advanced-deployment-options/aws.md b/docs/getting-started/advanced-deployment-options/aws/aws.md similarity index 93% rename from docs/getting-started/advanced-deployment-options/aws.md rename to docs/getting-started/advanced-deployment-options/aws/aws.md index 4f9e94c5..2c0b02fe 100644 --- a/docs/getting-started/advanced-deployment-options/aws.md +++ b/docs/getting-started/advanced-deployment-options/aws/aws.md @@ -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 @@ -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. diff --git a/docs/getting-started/advanced-deployment-options/aws_ami.png b/docs/getting-started/advanced-deployment-options/aws/aws_ami.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_ami.png rename to docs/getting-started/advanced-deployment-options/aws/aws_ami.png diff --git a/docs/getting-started/advanced-deployment-options/aws_instance_type.png b/docs/getting-started/advanced-deployment-options/aws/aws_instance_type.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_instance_type.png rename to docs/getting-started/advanced-deployment-options/aws/aws_instance_type.png diff --git a/docs/getting-started/advanced-deployment-options/aws_network.png b/docs/getting-started/advanced-deployment-options/aws/aws_network.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_network.png rename to docs/getting-started/advanced-deployment-options/aws/aws_network.png diff --git a/docs/getting-started/advanced-deployment-options/cli-installation.png b/docs/getting-started/advanced-deployment-options/cli/cli-installation.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/cli-installation.png rename to docs/getting-started/advanced-deployment-options/cli/cli-installation.png diff --git a/docs/getting-started/advanced-deployment-options/cuda.md b/docs/getting-started/advanced-deployment-options/cuda/cuda.md similarity index 100% rename from docs/getting-started/advanced-deployment-options/cuda.md rename to docs/getting-started/advanced-deployment-options/cuda/cuda.md diff --git a/docs/getting-started/advanced-deployment-options/docker.md b/docs/getting-started/advanced-deployment-options/docker/docker.md similarity index 100% rename from docs/getting-started/advanced-deployment-options/docker.md rename to docs/getting-started/advanced-deployment-options/docker/docker.md diff --git a/docs/getting-started/advanced-deployment-options/gaia-cli-installation.png b/docs/getting-started/advanced-deployment-options/gaia/gaia-cli-installation.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaia-cli-installation.png rename to docs/getting-started/advanced-deployment-options/gaia/gaia-cli-installation.png diff --git a/docs/getting-started/advanced-deployment-options/gaianet-init.png b/docs/getting-started/advanced-deployment-options/gaia/gaianet-init.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaianet-init.png rename to docs/getting-started/advanced-deployment-options/gaia/gaianet-init.png diff --git a/docs/getting-started/advanced-deployment-options/gaianet-start.png b/docs/getting-started/advanced-deployment-options/gaia/gaianet-start.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaianet-start.png rename to docs/getting-started/advanced-deployment-options/gaia/gaianet-start.png diff --git a/docs/getting-started/advanced-deployment-options/windows.md b/docs/getting-started/advanced-deployment-options/windows.md index 75123036..89383880 100644 --- a/docs/getting-started/advanced-deployment-options/windows.md +++ b/docs/getting-started/advanced-deployment-options/windows.md @@ -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 @@ -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! diff --git a/docs/getting-started/advanced-deployment-options/installation-complete.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/installation-complete.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/installation-complete.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/installation-complete.png diff --git a/docs/getting-started/advanced-deployment-options/launching-ubuntu.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/launching-ubuntu.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/launching-ubuntu.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/launching-ubuntu.png diff --git a/docs/getting-started/advanced-deployment-options/wsl-install-ubuntu.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-install-ubuntu.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/wsl-install-ubuntu.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-install-ubuntu.png diff --git a/docs/getting-started/advanced-deployment-options/wsl-installer.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-installer.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/wsl-installer.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-installer.png diff --git a/docs/getting-started/api-key-created.png b/docs/getting-started/api/api-key-created.png similarity index 100% rename from docs/getting-started/api-key-created.png rename to docs/getting-started/api/api-key-created.png diff --git a/docs/getting-started/create-api-key.png b/docs/getting-started/api/create-api-key.png similarity index 100% rename from docs/getting-started/create-api-key.png rename to docs/getting-started/api/create-api-key.png diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication/authentication.md similarity index 82% rename from docs/getting-started/authentication.md rename to docs/getting-started/authentication/authentication.md index b53cd808..f0a81f5a 100644 --- a/docs/getting-started/authentication.md +++ b/docs/getting-started/authentication/authentication.md @@ -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** @@ -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 @@ -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. diff --git a/docs/getting-started/chat_button.png b/docs/getting-started/chat-button/chat_button.png similarity index 100% rename from docs/getting-started/chat_button.png rename to docs/getting-started/chat-button/chat_button.png diff --git a/docs/getting-started/cli-options.md b/docs/getting-started/cli-options/cli-options.md similarity index 93% rename from docs/getting-started/cli-options.md rename to docs/getting-started/cli-options/cli-options.md index 8e7160d2..c41aef9d 100644 --- a/docs/getting-started/cli-options.md +++ b/docs/getting-started/cli-options/cli-options.md @@ -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 @@ -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`. diff --git a/docs/getting-started/customize.md b/docs/getting-started/customize/customize.md similarity index 100% rename from docs/getting-started/customize.md rename to docs/getting-started/customize/customize.md diff --git a/docs/getting-started/disable_autoMemoryReclaim_wsl.png b/docs/getting-started/disable-automemory/disable_autoMemoryReclaim_wsl.png similarity index 100% rename from docs/getting-started/disable_autoMemoryReclaim_wsl.png rename to docs/getting-started/disable-automemory/disable_autoMemoryReclaim_wsl.png diff --git a/docs/getting-started/gaia-protocol copy.png b/docs/getting-started/gaia-protocol/gaia-protocol copy.png similarity index 100% rename from docs/getting-started/gaia-protocol copy.png rename to docs/getting-started/gaia-protocol/gaia-protocol copy.png diff --git a/docs/getting-started/gaia-protocol.png b/docs/getting-started/gaia-protocol/gaia-protocol.png similarity index 100% rename from docs/getting-started/gaia-protocol.png rename to docs/getting-started/gaia-protocol/gaia-protocol.png diff --git a/docs/getting-started/install.md b/docs/getting-started/install/install.md similarity index 100% rename from docs/getting-started/install.md rename to docs/getting-started/install/install.md diff --git a/docs/getting-started/mynode.md b/docs/getting-started/mynode/mynode.md similarity index 92% rename from docs/getting-started/mynode.md rename to docs/getting-started/mynode/mynode.md index a838f0c5..1a0252cf 100644 --- a/docs/getting-started/mynode.md +++ b/docs/getting-started/mynode/mynode.md @@ -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) diff --git a/docs/getting-started/node-register.png b/docs/getting-started/mynode/node-register.png similarity index 100% rename from docs/getting-started/node-register.png rename to docs/getting-started/mynode/node-register.png diff --git a/docs/getting-started/what-is-a-node.md b/docs/getting-started/mynode/what-is-a-node.md similarity index 98% rename from docs/getting-started/what-is-a-node.md rename to docs/getting-started/mynode/what-is-a-node.md index f84f852d..28b8a8f0 100644 --- a/docs/getting-started/what-is-a-node.md +++ b/docs/getting-started/mynode/what-is-a-node.md @@ -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) \ No newline at end of file +![Gaia Protocol](../openai/openai_api_options.png) \ No newline at end of file diff --git a/docs/getting-started/openai_api_options.png b/docs/getting-started/openai/openai_api_options.png similarity index 100% rename from docs/getting-started/openai_api_options.png rename to docs/getting-started/openai/openai_api_options.png diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start/quick-start.md similarity index 85% rename from docs/getting-started/quick-start.md rename to docs/getting-started/quick-start/quick-start.md index 0a581df2..1f5e6f68 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start/quick-start.md @@ -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. diff --git a/docs/getting-started/quick-start.png b/docs/getting-started/quick-start/quick-start.png similarity index 100% rename from docs/getting-started/quick-start.png rename to docs/getting-started/quick-start/quick-start.png diff --git a/docs/getting-started/register-01.png b/docs/getting-started/register/register-01.png similarity index 100% rename from docs/getting-started/register-01.png rename to docs/getting-started/register/register-01.png diff --git a/docs/getting-started/register.md b/docs/getting-started/register/register.md similarity index 98% rename from docs/getting-started/register.md rename to docs/getting-started/register/register.md index a54c44b0..0243339a 100644 --- a/docs/getting-started/register.md +++ b/docs/getting-started/register/register.md @@ -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: @@ -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. diff --git a/docs/getting-started/settings-for-api-keys.png b/docs/getting-started/settings-for-api/settings-for-api-keys.png similarity index 100% rename from docs/getting-started/settings-for-api-keys.png rename to docs/getting-started/settings-for-api/settings-for-api-keys.png diff --git a/docs/getting-started/settings-for-api.png b/docs/getting-started/settings-for-api/settings-for-api.png similarity index 100% rename from docs/getting-started/settings-for-api.png rename to docs/getting-started/settings-for-api/settings-for-api.png diff --git a/docs/getting-started/system-requirements.md b/docs/getting-started/system-requirements/system-requirements.md similarity index 100% rename from docs/getting-started/system-requirements.md rename to docs/getting-started/system-requirements/system-requirements.md diff --git a/docs/getting-started/troubleshooting-01.png b/docs/getting-started/troubleshooting/troubleshooting-01.png similarity index 100% rename from docs/getting-started/troubleshooting-01.png rename to docs/getting-started/troubleshooting/troubleshooting-01.png diff --git a/docs/getting-started/troubleshooting.md b/docs/getting-started/troubleshooting/troubleshooting.md similarity index 98% rename from docs/getting-started/troubleshooting.md rename to docs/getting-started/troubleshooting/troubleshooting.md index 02e7dbfe..91c38b06 100644 --- a/docs/getting-started/troubleshooting.md +++ b/docs/getting-started/troubleshooting/troubleshooting.md @@ -42,7 +42,7 @@ The solution is to disable the `autoMemoryReclaim` feature in WSL. Step to turn 1. Edit `C:\Users.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). @@ -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 `` folder. diff --git a/docs/intro.md b/docs/intro.md index 5591fcb9..afbf2ddb 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -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. @@ -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). \ No newline at end of file +* [Create your own knowledge base](/knowledge-bases). +* [Finetune a model to "speak" like you](/tutorial/llamacpp). \ No newline at end of file diff --git a/docs/knowledge-bases/how-to/csv.md b/docs/knowledge-bases/how-to/csv/csv.md similarity index 100% rename from docs/knowledge-bases/how-to/csv.md rename to docs/knowledge-bases/how-to/csv/csv.md diff --git a/docs/knowledge-bases/how-to/firecrawl-01.png b/docs/knowledge-bases/how-to/firecrawl/firecrawl-01.png similarity index 100% rename from docs/knowledge-bases/how-to/firecrawl-01.png rename to docs/knowledge-bases/how-to/firecrawl/firecrawl-01.png diff --git a/docs/knowledge-bases/how-to/firecrawl.md b/docs/knowledge-bases/how-to/firecrawl/firecrawl.md similarity index 88% rename from docs/knowledge-bases/how-to/firecrawl.md rename to docs/knowledge-bases/how-to/firecrawl/firecrawl.md index 5df8af73..36f21acb 100644 --- a/docs/knowledge-bases/how-to/firecrawl.md +++ b/docs/knowledge-bases/how-to/firecrawl/firecrawl.md @@ -4,7 +4,7 @@ sidebar_position: 12 # Knowledge base from a URL -In this section, we will discuss how to create a vector collection snapshot from a Web URL. First, we will parse the URL to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](markdown.md) to create embedding for your URL. +In this section, we will discuss how to create a vector collection snapshot from a Web URL. First, we will parse the URL to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](../markdown/markdown.md) to create embedding for your URL. ## Parse the URL content to a markdown file @@ -45,4 +45,4 @@ The output markdown file will be located in this folder named `output.md`. ## Create embeddings from the markdown files -Please follow the tutorial [Knowledge base from a markdown file](markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. +Please follow the tutorial [Knowledge base from a markdown file](../markdown/markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. diff --git a/docs/knowledge-bases/how-to/markdown.md b/docs/knowledge-bases/how-to/markdown/markdown.md similarity index 100% rename from docs/knowledge-bases/how-to/markdown.md rename to docs/knowledge-bases/how-to/markdown/markdown.md diff --git a/docs/knowledge-bases/how-to/pdf.md b/docs/knowledge-bases/how-to/pdf/pdf.md similarity index 85% rename from docs/knowledge-bases/how-to/pdf.md rename to docs/knowledge-bases/how-to/pdf/pdf.md index 7ba96259..fb5d0a45 100644 --- a/docs/knowledge-bases/how-to/pdf.md +++ b/docs/knowledge-bases/how-to/pdf/pdf.md @@ -4,7 +4,7 @@ sidebar_position: 11 # Knowledge base from a PDF file -In this section, we will discuss how to create a vector collection snapshot from a PDF file. First, we will parse the unstructured PDF file to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](markdown.md) to create embedding for your PDF files. +In this section, we will discuss how to create a vector collection snapshot from a PDF file. First, we will parse the unstructured PDF file to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](/docs/knowledge-bases/how-to/markdown/markdown.md) to create embedding for your PDF files. ## Tools to convert a PDF file to a markdown file @@ -61,4 +61,4 @@ The output markdown files called `output.md` will be located in your root direct ## Create embeddings from the markdown files -Please follow the tutorial [Knowledge base from a markdown file](markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. +Please follow the tutorial [Knowledge base from a markdown file](/docs/knowledge-bases/how-to/markdown/markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. diff --git a/docs/knowledge-bases/how-to/text.md b/docs/knowledge-bases/how-to/text/text.md similarity index 100% rename from docs/knowledge-bases/how-to/text.md rename to docs/knowledge-bases/how-to/text/text.md diff --git a/docs/knowledge-bases/how-to/web-tool.md b/docs/knowledge-bases/how-to/web-tool/web-tool.md similarity index 93% rename from docs/knowledge-bases/how-to/web-tool.md rename to docs/knowledge-bases/how-to/web-tool/web-tool.md index b8d450ec..57aa8076 100644 --- a/docs/knowledge-bases/how-to/web-tool.md +++ b/docs/knowledge-bases/how-to/web-tool/web-tool.md @@ -27,5 +27,5 @@ Blockchain software is like any other software. The first of its kind was Bitcoi Once you have the chunked knowledge base in either `.txt` or `.md` formats, you can follow our tutorials to convert into a Qdrant vector database snapshot: -- [Text to embeddings](/docs/knowledge-bases/how-to/text.md) -- [Markdown to embeddings](/docs/knowledge-bases/how-to/markdown.md) \ No newline at end of file +- [Text to embeddings](../text/text.md) +- [Markdown to embeddings](../markdown/markdown.md) \ No newline at end of file diff --git a/docs/knowledge-bases/how-to/web_tool_input.png b/docs/knowledge-bases/how-to/web-tool/web_tool_input.png similarity index 100% rename from docs/knowledge-bases/how-to/web_tool_input.png rename to docs/knowledge-bases/how-to/web-tool/web_tool_input.png diff --git a/docs/litepaper.md b/docs/litepaper/litepaper.md similarity index 98% rename from docs/litepaper.md rename to docs/litepaper/litepaper.md index e8eb76b9..ac6153c3 100644 --- a/docs/litepaper.md +++ b/docs/litepaper/litepaper.md @@ -25,7 +25,7 @@ Agents are software applications that can complete tasks on its own autonomously * to answer “politically incorrect” questions (e.g., to analyze CVE exploits for an agent in the security domain). * and to answer requests in a specific style (e.g., to mimic a person). -![What is a GaiaNet agent](gaianet_agent.png) +![What is a GaiaNet agent](../gaianet/gaianet_agent.png) Agents are complex software that require significant amount of engineering and resources. Today, most agents are close-source and hosted on SaaS-based LLMs. Popular examples include GPTs and Microsoft/GitHub copilots on OpenAI LLMs, and Duet on Google’s Gemini LLMs. @@ -43,7 +43,7 @@ In this paper, we propose a decentralized software platform and protocol network As of April 2024, there are over 6000 open-source LLMs published on Hugging face. Compared with close-source LLMs, such as GPT-4, open-source LLMs offer advantages in privacy, cost, and systematic bias. Even with general QA performance, open-source LLMs are closing the gap with close-source counterparties quickly. -![Open vs close source LLMs](closed_vs_open.jpg) +![Open vs close source LLMs](../close_vs_open/closed_vs_open.jpg) For AI agent use cases, it has been demonstrated that smaller but task-specific LLMs often outperform larger general models. @@ -57,7 +57,7 @@ The GaiaNet project provides a cross-platform and highly efficient SDK and runti The basic operational unit in the GaiaNet network is a node. A GaiaNet node is a streamlined software stack that allows any technically competent person to run an AI agent of his own. The software stack on the GaiaNet node consists of the following 7 key components. -![GaiaNet node architecture](gaianet_node.png) +![GaiaNet node architecture](../gaianet/gaianet_node.png) **1 Application runtime.** GaiaNet applications run in a lightweight, secure and high-performance sandbox called WasmEdge. As an open-source project managed by the Linux Foundation and CNCF, WasmEdge runtime works seamlessly with leading cloud native tools such as Docker, containerd, CRI-O, Podman and Kubernetes. It is also the virtual machine of choice by leading public blockchains to securely and efficiently execute on-chain and off-chain smart contracts. @@ -140,7 +140,7 @@ Those challenges have given rise to the GaiaNet domain, which forms the basis of * Getting paid by users. * Pay nodes for their services. -![GaiaNet network architecture](gaianet_eco.png) +![GaiaNet network architecture](../gaianet/gaianet_eco.png) Each GaiaNet node has an unique node ID in the form of an ETH address. The private key associated with the ETH address is stored on the node. Once a node is successfully registered with a domain, it is entitled to receive payments from both service revenue and network awards from the domain. The domain could send payments directly to the node's ETH address. Or, the domain could provide a mechanism for a node operator to register multiple nodes under a single Metamask address, such as signing a challenge phrase using the node private keys. In that case, the node operator will receive aggregated payments in his Metamask account for all associated nodes. diff --git a/docs/node-operators.md b/docs/nodes/node-operators.md similarity index 100% rename from docs/node-operators.md rename to docs/nodes/node-operators.md diff --git a/docs/nodes.md b/docs/nodes/nodes.md similarity index 88% rename from docs/nodes.md rename to docs/nodes/nodes.md index 117b2f55..8a872b39 100644 --- a/docs/nodes.md +++ b/docs/nodes/nodes.md @@ -23,7 +23,7 @@ Replace OpenAI configuration in [your app](./agent-integrations/intro) with the |-----|--------| | API endpoint URL | https://whisper.gaia.domains/v1 | | Model Name | whisper | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Text-to-image: Realistic vision @@ -35,7 +35,7 @@ Replace OpenAI configuration in [your app](./agent-integrations/intro) with the |-----|--------| | API endpoint URL | https://portrait.gaia.domains/v1 | | Model Name | portrait | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Text-to-voice: GPT-SoVITS @@ -55,7 +55,7 @@ Replace OpenAI configuration in [your app](./agent-integrations/intro) with the | API endpoint URL | https://coder.gaia.domains/v1 | | Model Name (for LLM) | coder | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Rust Coder @@ -68,7 +68,7 @@ Replace OpenAI configuration in [your app](./agent-integrations/intro) with the | API endpoint URL | https://rustcoder.gaia.domains/v1 | | Model Name (for LLM) | rustcoder | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ## Alternative LLM domains @@ -97,7 +97,7 @@ The Qwen 7b LLM is great for non-English tasks such as translation. | API endpoint URL | https://qwen7b.gaia.domains/v1 | | Model Name (for LLM) | qwen7b | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Qwen 72b @@ -112,4 +112,4 @@ It is capable of tool / function calling. | API endpoint URL | https://qwen72b.gaia.domains/v1 | | Model Name (for LLM) | qwen72b | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | diff --git a/docs/templates-and-examples/examples/cdp-image.png b/docs/templates-and-examples/examples/cdp/cdp-image.png similarity index 100% rename from docs/templates-and-examples/examples/cdp-image.png rename to docs/templates-and-examples/examples/cdp/cdp-image.png diff --git a/docs/templates-and-examples/examples/coinbase-agentkit-starter.md b/docs/templates-and-examples/examples/coinbase-agent/coinbase-agentkit-starter.md similarity index 99% rename from docs/templates-and-examples/examples/coinbase-agentkit-starter.md rename to docs/templates-and-examples/examples/coinbase-agent/coinbase-agentkit-starter.md index f933efc5..30e04700 100644 --- a/docs/templates-and-examples/examples/coinbase-agentkit-starter.md +++ b/docs/templates-and-examples/examples/coinbase-agent/coinbase-agentkit-starter.md @@ -10,7 +10,7 @@ This template shows an onchain agent powered by Coinbase's AgentKit with the Nex AgentKit handles these interactions by using a Gaia node for Large Language Model (LLM) inferencing. -![cdp-image](./cdp-image.png) +![cdp-image](../cdp/cdp-image.png) ## Features diff --git a/docs/templates-and-examples/examples/dynamic-rag.md b/docs/templates-and-examples/examples/dynamic-rag/dynamic-rag.md similarity index 100% rename from docs/templates-and-examples/examples/dynamic-rag.md rename to docs/templates-and-examples/examples/dynamic-rag/dynamic-rag.md diff --git a/docs/templates-and-examples/examples/gaia-dtk-2.gif b/docs/templates-and-examples/examples/gaia/gaia-dtk-2.gif similarity index 100% rename from docs/templates-and-examples/examples/gaia-dtk-2.gif rename to docs/templates-and-examples/examples/gaia/gaia-dtk-2.gif diff --git a/docs/templates-and-examples/examples/gaia-supavec.md b/docs/templates-and-examples/examples/gaia/gaia-supavec.md similarity index 100% rename from docs/templates-and-examples/examples/gaia-supavec.md rename to docs/templates-and-examples/examples/gaia/gaia-supavec.md diff --git a/docs/templates-and-examples/examples/metamask-gaia-starter.md b/docs/templates-and-examples/examples/metamask/metamask-gaia-starter.md similarity index 99% rename from docs/templates-and-examples/examples/metamask-gaia-starter.md rename to docs/templates-and-examples/examples/metamask/metamask-gaia-starter.md index ff67b1b9..163451dc 100644 --- a/docs/templates-and-examples/examples/metamask-gaia-starter.md +++ b/docs/templates-and-examples/examples/metamask/metamask-gaia-starter.md @@ -8,7 +8,7 @@ sidebar_position: 1 The MetaMask Gaia DTK Starter is a powerful Next.js template that seamlessly integrates Gaia's advanced capabilities with MetaMask's Develegation Toolkit (DTK). This project allows developers to build sophisticated blockchain applications with AI-enhanced functionalities while leveraging MetaMask's secure wallet infrastructure. -![Gaia Delegation Toolkit Gif](./gaia-dtk-2.gif) +![Gaia Delegation Toolkit Gif](../gaia/gaia-dtk-2.gif) The starter includes a full ERC20 token creation system through an integrated factory contract, allowing users to deploy custom tokens directly through the application. Combined with AI-powered interactions, this creates a powerful platform for building next-generation decentralized applications. diff --git a/docs/templates-and-examples/examples/nubila.md b/docs/templates-and-examples/examples/nubila/nubila.md similarity index 100% rename from docs/templates-and-examples/examples/nubila.md rename to docs/templates-and-examples/examples/nubila/nubila.md diff --git a/docs/templates-and-examples/examples/pdf-rag-1.png b/docs/templates-and-examples/examples/pdf/pdf-rag-1.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-1.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-1.png diff --git a/docs/templates-and-examples/examples/pdf-rag-2.png b/docs/templates-and-examples/examples/pdf/pdf-rag-2.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-2.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-2.png diff --git a/docs/templates-and-examples/examples/pdf-rag-3.png b/docs/templates-and-examples/examples/pdf/pdf-rag-3.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-3.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-3.png diff --git a/docs/templates-and-examples/examples/pdf-rag-4.png b/docs/templates-and-examples/examples/pdf/pdf-rag-4.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-4.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-4.png diff --git a/docs/templates-and-examples/examples/pdf-rag-5.png b/docs/templates-and-examples/examples/pdf/pdf-rag-5.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-5.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-5.png diff --git a/docs/templates-and-examples/examples/pdf-rag-6.png b/docs/templates-and-examples/examples/pdf/pdf-rag-6.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-6.png rename to docs/templates-and-examples/examples/pdf/pdf-rag-6.png diff --git a/docs/templates-and-examples/examples/pdf-rag.md b/docs/templates-and-examples/examples/pdf/pdf-rag.md similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag.md rename to docs/templates-and-examples/examples/pdf/pdf-rag.md diff --git a/docs/templates-and-examples/examples/story-weaver.md b/docs/templates-and-examples/examples/story-weaver/story-weaver.md similarity index 100% rename from docs/templates-and-examples/examples/story-weaver.md rename to docs/templates-and-examples/examples/story-weaver/story-weaver.md diff --git a/docs/templates-and-examples/examples/base-token-generator.md b/docs/templates-and-examples/examples/token/base-token-generator.md similarity index 100% rename from docs/templates-and-examples/examples/base-token-generator.md rename to docs/templates-and-examples/examples/token/base-token-generator.md diff --git a/docs/templates-and-examples/examples/celo-token-generator.md b/docs/templates-and-examples/examples/token/celo-token-generator.md similarity index 100% rename from docs/templates-and-examples/examples/celo-token-generator.md rename to docs/templates-and-examples/examples/token/celo-token-generator.md diff --git a/docs/templates-and-examples/examples/zerion-tool-call.md b/docs/templates-and-examples/examples/zerion/zerion-tool-call.md similarity index 100% rename from docs/templates-and-examples/examples/zerion-tool-call.md rename to docs/templates-and-examples/examples/zerion/zerion-tool-call.md diff --git a/docs/templates-and-examples/templates/ai-voting.gif b/docs/templates-and-examples/templates/ai-voting/ai-voting.gif similarity index 100% rename from docs/templates-and-examples/templates/ai-voting.gif rename to docs/templates-and-examples/templates/ai-voting/ai-voting.gif diff --git a/docs/templates-and-examples/templates/chatbot-widget.md b/docs/templates-and-examples/templates/chatbot/chatbot-widget.md similarity index 100% rename from docs/templates-and-examples/templates/chatbot-widget.md rename to docs/templates-and-examples/templates/chatbot/chatbot-widget.md diff --git a/docs/templates-and-examples/templates/developer-docs-ai-agent.md b/docs/templates-and-examples/templates/developer-docs/developer-docs-ai-agent.md similarity index 100% rename from docs/templates-and-examples/templates/developer-docs-ai-agent.md rename to docs/templates-and-examples/templates/developer-docs/developer-docs-ai-agent.md diff --git a/docs/templates-and-examples/templates/gaia-web3-voting-starter.md b/docs/templates-and-examples/templates/gaia/gaia-web3-voting-starter.md similarity index 99% rename from docs/templates-and-examples/templates/gaia-web3-voting-starter.md rename to docs/templates-and-examples/templates/gaia/gaia-web3-voting-starter.md index 39a02b2c..13e1668f 100644 --- a/docs/templates-and-examples/templates/gaia-web3-voting-starter.md +++ b/docs/templates-and-examples/templates/gaia/gaia-web3-voting-starter.md @@ -6,7 +6,7 @@ sidebar_position: 2 # Gaia Web3 Voting Starter -![Gaia AI Voting](./ai-voting.gif) +![Gaia AI Voting](../ai-voting/ai-voting.gif) A decentralized voting application built with Next.js, Hardhat, and [Gaia](https://docs.gaianet.ai/intro/). You can create voting situation and select the choices you want to vote and vote it with the AI Agent. diff --git a/docs/templates-and-examples/templates/notion-gaia-assistant.md b/docs/templates-and-examples/templates/gaia/notion-gaia-assistant.md similarity index 100% rename from docs/templates-and-examples/templates/notion-gaia-assistant.md rename to docs/templates-and-examples/templates/gaia/notion-gaia-assistant.md diff --git a/docs/tutorial/coinbase.md b/docs/tutorial/coinbase/coinbase.md similarity index 98% rename from docs/tutorial/coinbase.md rename to docs/tutorial/coinbase/coinbase.md index dad6e8fc..ce5da080 100644 --- a/docs/tutorial/coinbase.md +++ b/docs/tutorial/coinbase/coinbase.md @@ -5,7 +5,7 @@ sidebar_position: 3 # Working with Coinbase AgentKit You can use a Gaia node to power the [Coinbase AgentKit](https://github.com/coinbase/agentkit). -The Gaia node must run an LLM that is optimized for [tool calling](tool-call.md). +The Gaia node must run an LLM that is optimized for [tool calling](../tool-call/tool-call.md). Or, you could simply use our public Gaia domain as follows. | Attribute | Value | diff --git a/docs/tutorial/concepts.md b/docs/tutorial/concepts/concepts.md similarity index 100% rename from docs/tutorial/concepts.md rename to docs/tutorial/concepts/concepts.md diff --git a/docs/tutorial/cursor-settings.png b/docs/tutorial/cursor/cursor-settings.png similarity index 100% rename from docs/tutorial/cursor-settings.png rename to docs/tutorial/cursor/cursor-settings.png diff --git a/docs/tutorial/deepseek-cursor.md b/docs/tutorial/deepseek/deepseek-cursor.md similarity index 93% rename from docs/tutorial/deepseek-cursor.md rename to docs/tutorial/deepseek/deepseek-cursor.md index 930407a3..2195895b 100644 --- a/docs/tutorial/deepseek-cursor.md +++ b/docs/tutorial/deepseek/deepseek-cursor.md @@ -57,16 +57,16 @@ We start the DeepSeek R1 model with an 8k context window by default. If your mac 1. Open Cursor settings -![Cursor Settings](cursor-settings.png) +![Cursor Settings](../cursor/cursor-settings.png) 2. Locate the LLM Backend configuration -![LLM Backend configuration](model-config.png) +![LLM Backend configuration](../model-config/model-config.png) 3. Configure the following: - Base API URL: Your Gaia node HTTPS URL - Model Name: `DeepSeek-R1-Distill-Llama-8B` - - API Key: Make sure to replace `YOUR_API_KEY_GOES_HERE` with your **own API key**. To get your own API key, follow [this](../getting-started/authentication) tutorial. + - API Key: Make sure to replace `YOUR_API_KEY_GOES_HERE` with your **own API key**. To get your own API key, follow [this](/docs/getting-started/authentication/authentication.md) tutorial. ![DeepSeek-R1 Setup](deepseek-setup.png) diff --git a/docs/tutorial/deepseek-setup.png b/docs/tutorial/deepseek/deepseek-setup.png similarity index 100% rename from docs/tutorial/deepseek-setup.png rename to docs/tutorial/deepseek/deepseek-setup.png diff --git a/docs/tutorial/eliza.md b/docs/tutorial/eliza/eliza.md similarity index 100% rename from docs/tutorial/eliza.md rename to docs/tutorial/eliza/eliza.md diff --git a/docs/tutorial/llamacpp.md b/docs/tutorial/llama/llamacpp.md similarity index 100% rename from docs/tutorial/llamacpp.md rename to docs/tutorial/llama/llamacpp.md diff --git a/docs/tutorial/model-config.png b/docs/tutorial/model-config/model-config.png similarity index 100% rename from docs/tutorial/model-config.png rename to docs/tutorial/model-config/model-config.png diff --git a/docs/tutorial/prompt-engineering-tool.md b/docs/tutorial/prompt-engineer/prompt-engineering-tool.md similarity index 100% rename from docs/tutorial/prompt-engineering-tool.md rename to docs/tutorial/prompt-engineer/prompt-engineering-tool.md diff --git a/docs/tutorial/tool-call.md b/docs/tutorial/tool-call/tool-call.md similarity index 100% rename from docs/tutorial/tool-call.md rename to docs/tutorial/tool-call/tool-call.md diff --git a/docs/tutorial/translator-agent.md b/docs/tutorial/translator-agent/translator-agent.md similarity index 99% rename from docs/tutorial/translator-agent.md rename to docs/tutorial/translator-agent/translator-agent.md index 199bbc19..1c7742de 100644 --- a/docs/tutorial/translator-agent.md +++ b/docs/tutorial/translator-agent/translator-agent.md @@ -39,7 +39,7 @@ export OPENAI_API_KEY="GAIANET" pip install python-dotenv pip install openai tiktoken icecream langchain_text_splitters ``` -> If you're using a Domain service, you will [need to get an API key from Gaia](../getting-started/authentication.md). +> If you're using a Domain service, you will [need to get an API key from Gaia](../../getting-started/authentication/authentication.md). ## Demo 1: Running Translation Agents with Llama-3-8B diff --git a/docusaurus.config.js b/docusaurus.config.js index eddabde8..827e0bd0 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -252,6 +252,7 @@ const config = { logo: { alt: 'Decentralizing Generative AI Chatbots and Agents', src: 'img/icon-white.png', + srcDark: 'img/icon-dark.png', }, items: [ // { diff --git a/src/css/custom.css b/src/css/custom.css index 27d8fc32..5f953bb7 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1,34 +1,25 @@ -/** - * Any CSS included here will be global. The classic template - * bundles Infima by default. Infima is a CSS framework designed to - * work well for content-centric websites. - */ - -/* You can override the default Infima variables here. */ -:root { - --ifm-color-primary: #3a3d41; - --ifm-color-primary-dark: #303337; - --ifm-color-primary-darker: #26292d; - --ifm-color-primary-darkest: #1c1f23; - --ifm-color-primary-light: #44474b; - --ifm-color-primary-lighter: #4e5155; - --ifm-color-primary-lightest: #585b5f; - --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); +/* === Light mode only: Glow Effect for Footer Links === */ +:root:not([data-theme='dark']) footer .footer__link, +:root:not([data-theme='dark']) .footer .footer__link { + position: relative; + display: inline-block; + padding: 2px 4px; + border-radius: 4px; + transition: all 0.3s ease; + text-decoration: none; } -/* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #f3d8b9; - --ifm-color-primary-dark: #e9ceaf; - --ifm-color-primary-darker: #dfc4a5; - --ifm-color-primary-darkest: #d5ba9b; - --ifm-color-primary-light: #fde2c3; - --ifm-color-primary-lighter: #ffeccd; - --ifm-color-primary-lightest: #fff6d7; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); +:root:not([data-theme='dark']) footer .footer__link:hover, +:root:not([data-theme='dark']) .footer .footer__link:hover { + text-shadow: + 0 0 5px rgba(58, 61, 65, 0.2), + 0 0 10px rgba(58, 61, 65, 0.15), + 0 0 15px rgba(58, 61, 65, 0.1); + box-shadow: + 0 0 5px rgba(58, 61, 65, 0.2), + 0 0 10px rgba(58, 61, 65, 0.1), + inset 0 0 5px rgba(58, 61, 65, 0.1); + background: rgba(58, 61, 65, 0.05); + transform: translateY(-1px); + color: #3a3d41; } - -article { - --ifm-link-decoration:underline; -} \ No newline at end of file diff --git a/static/img/icon-dark.png b/static/img/icon-dark.png new file mode 100644 index 00000000..beb90f2b Binary files /dev/null and b/static/img/icon-dark.png differ diff --git a/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md b/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md index 4fce2f60..ef19c2ee 100644 --- a/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md +++ b/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md @@ -21,7 +21,7 @@ domain or background. > For example, if you ask ChatGPT the question What is Layer 2, the answer is that Layer 2 is a concept from the computer network. However, if you ask a blockchain person, they answer that Layer 2 is a way to scale the original Ethereum network. That's the difference between a generic LLM and knowledge-supplemented LLMs. -We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](/docs/getting-started/quick-start.md) to start building one. +We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](/docs/getting-started/quick-start/quick-start.md) to start building one. 1. Create embeddings for your own knowledge as the long-term memory. 2. Lifecycle of a user query on a knowledge-supplemented LLM. @@ -45,7 +45,7 @@ After chunking the document, we can convert these chunks into embeddings leverag Additionally, we will need a vector DB to store the embeddings so that we can retrieve these embeddings quickly at any time. -On a Gaia node, we will get a database snapshot with the embeddings to use at last. Check out how to create your embeddings [from a plain text file](text.md), and [from a markdown file](markdown.md). +On a Gaia node, we will get a database snapshot with the embeddings to use at last. Check out how to create your embeddings [from a plain text file](/docs/knowledge-bases/how-to/text/text.md), and [from a markdown file](/docs/knowledge-bases/how-to/markdown/markdown.md). ## Lifecycle of a user query on a knowledge-supplemented LLM diff --git a/versioned_docs/version-1.0.0/user-guide/apps/dify.md b/versioned_docs/version-1.0.0/user-guide/apps/dify.md index b1ea8629..adbf5e45 100644 --- a/versioned_docs/version-1.0.0/user-guide/apps/dify.md +++ b/versioned_docs/version-1.0.0/user-guide/apps/dify.md @@ -15,18 +15,18 @@ or community GaiaNet nodes in any application built on Dify. It supports First, log into Dify's web portal and select `Settings | Model Provider`. From the list, you can add an OpenAI-API-compatible provider. -Add an LLM model with the modela name and API endpoint listed on your GaiaNet node's web dashboard. Or, you can just add [a popular GaiaNet node](../nodes). +Add an LLM model with the model name and API endpoint listed on your GaiaNet node's web dashboard. Or, you can just add [a popular GaiaNet node](../nodes). Leave the API Key field empty. ![Configure a GaiaNet 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 GaiaNet node's web dashboard. Or, you can just add [a popular GaiaNet node](../nodes). +Add an embedding model with the model name and API endpoint listed on your GaiaNet node's web dashboard. Or, you can just add [a popular GaiaNet node](../nodes). Leave the API Key field empty. ![Configure a GaiaNet 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 GaiaNet 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 GaiaNet models for chat or embedding, and the Dify app will automatically use it! ![Select a GaiaNet node as backend model in Dify](dify_select.png)