Revamp and modernize docs completely for 1.4.0 #136
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ahuang11
changed the title
|
I think I'm going to go with core & recipes |
Sounds good. Alternative you could use Tutorials and How-to guide terminology of Diataxis. |
|
Okay, I finally got around to updating this. I de-duplicated some recipes, but I couldn't get talk to github working run-llama/llama_index#12019 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?
Screen.Recording.2024-03-15.at.7.44.13.PM.mov
Closes #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: