Skip to content

Commit

Permalink
Merge pull request #184 from sambarza/small-fix
Browse files Browse the repository at this point in the history
Small fixes
  • Loading branch information
sambarza authored Sep 9, 2024
2 parents e170070 + eda3491 commit 349b9a8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 6 additions & 5 deletions mkdocs/quickstart/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
There are a few things you need to know about the Cheshire Cat. If you are eager to launch and start hacking, jump to the [installation page](installation-configuration.md), but please be sure to return here.

The Cheshire Cat is a ready-to-use AI micro-framework.
Once installed and connected to a Language Model (LLM), it can be queried through APIs.
Once installed and connected to a Large Language Model (LLM), it can be queried through APIs.
These APIs return the responses provided by the LLM.

But this is just the beginning.
Expand All @@ -16,7 +16,7 @@ When you ask a question, the Cat answers taking into account the past conversati
You can load text documents as well.
These documents are also saved in a local database called `declarative memory`.
When answering, the Cat will consider the information within these documents.
Documents can be uploaded through the APIs or the Admin Portal.
Documents can be uploaded through the APIs or the `Admin Portal`.

The `Rabbit Hole` is the component responsible for the document ingestion.

Expand All @@ -32,16 +32,17 @@ You can write Python functions that can be attached onto these `Hooks`.
The attached code will be invoked during the flow's execution and can modify the Cheshire Cat's internal behavior,
without directly modifying the core of the Cheshire Cat.

`Tools` and `Hooks` are packaged into `Plugins` that can be installed by placing files in a specific folder or using the Admin Portal.
`Tools` and `Hooks` are packaged into `Plugins` that can be installed by placing files in a specific folder or using the `Admin Portal`.

The `Mad Hatter` is the component that manages plugins.

## Sharing Plugins
If desired, you can publish your `Plugins` on the public registry.
Other users will be able to install them with just a single click.

## Admin Portal
A web portal for Admin users completes the framework.
Using this portal, the admin can configure the settings, install plugins, upload documents and use it as a playground tool.
A web portal for admin users completes the framework.
Using this portal, the admin can configure the settings, upload documents, install plugins and use it as a playground tool.
You can chat with the Cheshire Cat, inspect its responses and directly query its memories.

## Next step
Expand Down
2 changes: 0 additions & 2 deletions mkdocs/quickstart/play-with-the-cat.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ Try to ask something about socks, e.g. "what do you know about socks?".
The Cat will give a generic answer.
Afterward, we will expand this general knowledge with more specific information.

You have learned how to use the playground to test your AI via the Admin Portal.

![Alt text](../assets/img/quickstart/play-with-the-cat/play-with-the-cat.png)


Expand Down

0 comments on commit 349b9a8

Please sign in to comment.