docs: adding ten agent faqs

Adding ten agent faqs
cyfyifanchen · Nov 25, 2024 · a0edf3c · a0edf3c
1 parent 6d5c15b
commit a0edf3c
Show file tree

Hide file tree

Showing 2 changed files with 137 additions and 0 deletions.
diff --git a/packages/docs/SUMMARY.md b/packages/docs/SUMMARY.md
@@ -0,0 +1,70 @@
+# Table of contents
+
+* [🌟 Welcome to TEN](README.md)
+* [Goal](vision/goal.md)
+* [Key Concepts](vision/key_concepts.md)
+* [Scenarios](vision/application_scenarios.md)
+
+## TEN Agent
+
+* [Overview](ten_agent/overview.md)
+* [Getting Started](ten_agent/getting_started.md)
+* [Customize TEN Agent](ten_agent/customize_your_agent.md)
+* [Create a Hello World Extension](ten_agent/create_a_hello_world_extension.md)
+* [Setup VSCode Inside Container](ten_agent/setting_up_vscode_for_development_inside_container.md)
+* [How does interrupt work in TEN-Agent](ten_agent/how_does_interrupt_work.md)
+* [Create an Extension with Predefined Type](ten_agent/create_an_extension_with_predefined_type/overview.md)
+  * [LLM Extension](ten_agent/create_an_extension_with_predefined_type/type_llm_extension.md)
+  * [LLM Tool Extension](ten_agent/create_an_extension_with_predefined_type/type_llm_tool_extension.md)
+* [FAQs](ten_agent/faqs.md)
+
+## TEN framework
+
+* [Overview](ten_framework/concept_overview.md)
+* [Development Process](ten_framework/development_process.md)
+* [Preparation](ten_framework/preparation.md)
+* [Addon System](ten_framework/addon_system.md)
+* [Version System](ten_framework/version_system.md)
+* [Metadata System](ten_framework/metadata_system.md)
+* [Message System](ten_framework/message_system.md)
+* [Type System](ten_framework/type_system.md)
+* [Schema System](ten_framework/schema_system.md)
+* [Build System](ten_framework/build_system.md)
+* [Graph](ten_framework/graph.md)
+* [Cloud Store](ten_framework/cloud_store.md)
+* [Debugging](ten_framework/debugging.md)
+* [Profiling](ten_framework/profiling.md)
+* [Dependencies](ten_framework/dependencies.md)
+
+### TEN Testing System
+
+* [For Users of TEN framework](ten_framework/ten_testing/for_users_of_ten_framework.md)
+* [For Developers of TEN framework](ten_framework/ten_testing/for_developers_of_ten_framework.md)
+
+### Binding
+
+* [Go](ten_framework/binding/go.md)
+
+### API Reference
+
+* [Required](ten_framework/api/required.md)
+* [Interface](ten_framework/api/interface.md)
+* [Log](ten_framework/api/log.md)
+
+### TEN Packages
+
+* [Overview](ten_framework/ten_packages/overview.md)
+* [App](ten_framework/ten_packages/app.md)
+* [Extension](ten_framework/ten_packages/extension.md)
+* [Python Async Extension](ten_framework/ten_packages/python_async_extension.md)
+
+### TEN Manager
+
+* [Overview](ten_framework/ten_manager/overview.md)
+* [Dev-Server](ten_framework/ten_manager/dev_server_cn.md)
+* [Check-Graph](ten_framework/ten_manager/check_graph.md)
+
+## Tutorials
+
+* [How to debug with logs](tutorials/how_to_debug_with_logs.md)
+* [How to run local AI model in Python extension](tutorials/how_to_run_local_model_in_python_extensions.md)
diff --git a/packages/docs/ten_agent/faqs.md b/packages/docs/ten_agent/faqs.md
@@ -0,0 +1,67 @@
+# FAQs
+
+## Where do I get the Agora APP ID and Agora APP Certificate?
+
+For people who are in the **Greater China region**:
+* Sign up an account on [shengwang.cn](https://console.shengwang.cn/), and create a project, then the ID and Certificate will be generated automatically.
+
+For people who are in the **Global region**:
+* Sign up an account on [agora.io](https://console.agora.io/), and create a project, then the ID and Certificate will be generated automatically.
+
+
+## How to check my internet connection?
+
+Please make sure that both of you your **HTTPS** and **SSH** are connected to the internet.
+
+Test **HTTPS** connection:
+
+{% code title=">_ Terminal" %}
+```bash
+ping www.google.com
+
+# You should see the following output:
+PING google.com (198.18.1.94): 56 data bytes
+64 bytes from 198.18.1.94: icmp_seq=0 ttl=64 time=0.099 ms
+64 bytes from 198.18.1.94: icmp_seq=1 ttl=64 time=0.121 ms
+```
+{% endcode %}
+
+Test **SSH** connection:
+
+{% code title=">_ Terminal" %}
+```
+curl www.google.com
+
+# You should see the following output:
+<html>
+<head><title>301 Moved Permanently</title></head>
+<body>
+<h1>301 Moved Permanently</h1>
+</body>
+</html>
+```
+{% endcode %}
+
+## How to refresh env file?
+
+To see updated changes during development, follow these steps:
+1. Stop the server
+2. Save changes to the `.env` file
+3. Run `source .env` to refresh the environment variables
+
+## Line-ending Issues on Windows
+
+Windows users occasionally encounter line-ending issues, which may result in errors like "agent/bin/start is not a valid directory".
+
+To fix this:
+1. Configure Git to automatically convert line endings to LF on Windows:
+
+{% code title=">_ Terminal" %}
+```bash
+git config --global core.autocrlf true
+```
+{% endcode %}
+
+2. Re-clone the repository
+
+Alternatively, you can download and extract the ZIP file directly from GitHub.