Skip to content

Commit

Permalink
Ll/rename faq (#581)
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeLalor committed Jul 26, 2024
1 parent 4f454a4 commit beac068
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 37 deletions.
4 changes: 2 additions & 2 deletions webui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ docker run -e "EIDOLON_SERVER=http://host.docker.internal:8080" -p 3000:3000 eid
docker run -e "EIDOLON_SERVER=http://172.17.0.1:8080" -p 3000:3000 eidolonai/webui:latest
```

🚨 Make sure you have an Eidolon machine running locally on port 8080. For instructions on how to run a machine, see our [getting started guide](https://www.eidolonai.com/docs/introduction/)
🚨 Make sure you have an Eidolon machine running locally on port 8080. For instructions on how to run a machine, see our [getting quickstart guide](https://www.eidolonai.com/docs/quickstart)

## Development Environment

Expand All @@ -41,7 +41,7 @@ Alternatively, you can check the [official Turbo Repo installation guide](https:

### Running Eidolon Machine

You will also need a running Eidolon Machine. For instructions on how to run a machine, see our [getting started guide](https://www.eidolonai.com/docs/introduction/)
You will also need a running Eidolon Machine. For instructions on how to run a machine, see our [quickstart guide](https://www.eidolonai.com/docs/quickstart)

### Setting Up Your Environment

Expand Down
2 changes: 1 addition & 1 deletion webui/apps/docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ export default defineConfig({
]
},
{
label: 'FAQ', link: '/docs/introduction'
label: 'FAQ', link: '/docs/faq'
},
{
label: 'Architecture',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,38 +1,8 @@
---
title: Introduction
description: This page gives a broad overview of Eidolon and the documentation
title: FAQ
description: Frequently Asked Questions
---


<div>
<a href="https://pypi.org/project/eidolon-ai-sdk/">
<img style="display: inline-block;" alt="PyPI - Version" src="https://img.shields.io/pypi/v/eidolon-ai-sdk?style=flat&label=eidolon-ai-sdk">
</a>
<a href="https://pypi.org/project/eidolon-ai-client/">
<img style="display: inline-block" alt="PyPI - Version" src="https://img.shields.io/pypi/v/eidolon-ai-client?style=flat&label=eidolon-ai-client">
</a>
<a href="https://github.com/eidolon-ai/eidolon">
<img style="display: inline-block;" alt="GitHub Test Status" src="https://img.shields.io/github/actions/workflow/status/eidolon-ai/eidolon/test_python.yml?style=flat&logo=github&label=test">
</a>
</div>


Welcome to the official documentation of Eidolon Agent Services, an open-source framework for designing and deploying agent-based services.

This page gives a broad overview of the framework and of this documentation, so that you know where to start if you are new to Eidolon or where to look if you need information on a specific feature.


## Before you Start

The [Quickstart Guide](/docs/quickstart/) is a great starting point for anyone new to the Eidolon Framework. There you will find a step-by-step tutorial on setting up and running your first project with Eidolon.

After that check out our [Recipes](/docs/recipes/chatbot) for inspiration and to see what is possible with Eidolon.

The [Builtin Components](/docs/components/symbolicmemory/overview) section contains an in-depth guide showcasing the features and capabilities of Eidolon. And if you're curious about the design behind Eidolon check out the [Architecture](/docs/architecture/introduction) section.


## Frequently Asked Questions

### What is an Agent?
An agent is software (or a software property) that supplements client requests. One very simple type in common use is the User-Agent parameter of a browser. This property tells a website the type and version of the browser that is being used. The site itself may respond with different tools or message types accordingly.

Expand Down
2 changes: 1 addition & 1 deletion webui/apps/docs/src/content/docs/docs/howto/webui.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ docker run -e "EIDOLON_SERVER=http://172.17.0.1:8080" -p 3000:3000 eidolonai/web
Head over to [localhost:3000](http://localhost:3000/) in your favorite browser and start interacting with the Eidolon
Web UI.

🚨 Make sure you have an Eidolon machine running locally on port 8080. For instructions on how to run a machine, see our [getting started guide](https://www.eidolonai.com/docs/introduction/)
🚨 Make sure you have an Eidolon machine running locally on port 8080. For instructions on how to run a machine, see our [quickstart guide](https://www.eidolonai.com/docs/quickstart)

🚨 We publish several apps that depend on different types of agents. Our [⭐dev-tool app⭐](http://localhost:3000/eidolon-apps/dev-tool)️ is a great place to start, and will
work for all agents.
2 changes: 1 addition & 1 deletion webui/apps/docs/src/navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const headerData = {
},
{
text: 'FAQ',
href: '/docs/introduction',
href: '/docs/faq',
},
{
text: 'Videos',
Expand Down

0 comments on commit beac068

Please sign in to comment.