holoviz-topics / panel-chat-examples

Examples of Chat Bots using Panels chat features: Traditional, LLMs, AI Agents, LangChain, OpenAI etc
https://holoviz-topics.github.io/panel-chat-examples/
MIT License
104 stars 28 forks source link

Revamp and modernize docs completely for 1.4.0 #136

Closed ahuang11 closed 1 month ago

ahuang11 commented 4 months ago

For basics + features, it's now merged into one (features) and the goal of this is to reduce redundancy across examples (e.g. async stream chat) and instead write straightforward recipes that users can copy/paste and slightly modify; also now includes highlights.

Still kind of debating on the section names. Features and Applications sound generic; maybe Concepts + Recipes is better?

https://github.com/holoviz-topics/panel-chat-examples/assets/15331990/d783ab04-caee-4959-9430-563a7b9a78ba

Closes https://github.com/holoviz-topics/panel-chat-examples/issues/131

For components, I don't think panel-chat-examples is the proper place to put them; instead I think those should be migrated into the official Panel repo since panel-chat-examples does not allow users to pip install.

For all the others, I am planning to curate them under applications and separate requirements since most users will only want to try OpenAI/Mistral/LangChain/LlamaIndex separately.

Still very much a WIP, but feedback appreciated.

TODO:

ahuang11 commented 4 months ago

I think I'm going to go with core & recipes

MarcSkovMadsen commented 4 months ago

I think I'm going to go with core & recipes

Sounds good. Alternative you could use Tutorials and How-to guide terminology of Diataxis.

ahuang11 commented 1 month ago

Okay, I finally got around to updating this. I de-duplicated some recipes, but I couldn't get talk to github working https://github.com/run-llama/llama_index/issues/12019