Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Re-organize conceptual docs #27047

Merged
merged 26 commits into from
Oct 23, 2024
Merged

Docs: Re-organize conceptual docs #27047

merged 26 commits into from
Oct 23, 2024

Conversation

eyurtsev
Copy link
Collaborator

@eyurtsev eyurtsev commented Oct 2, 2024

Reorganization of conceptual documentation

Copy link

vercel bot commented Oct 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langchain ✅ Ready (Inspect) Visit Preview 21 resolved Oct 23, 2024 2:07am

Starting to structure the scaffold for the concepts. Moving concept
content into their own pages.

TBD what we'll end up doing with the actual concepts page in terms of
visual layout.
Re-organizing some of the content involves runnables/lcel/streaming into
conceptual guides.

Conceptual guides added:
- [x] Runnables
- [x] LCEL
- [x] Chat Models
- [x] LLM
- [x] async
- [x] Messages
- [x] Chat History
- [x] Multimodality
- [x] Tokenization

Outstanding:
- [ ] Callbacks/Tracers
- [ ] Streaming
- [ ] Tool Creation
- [ ] Document Loading


Other conceptual guides are placeholders to make sure that no existing
links breaks.

Some high level re-organization:

* Introduce the Runnable interface prior to LCEL (since those are two
distinct concepts)
* Cross-link as much related content as possible (including how-to
guides)
Add tools conceptual page
* Fix some typos
* Add some missing links
eyurtsev and others added 6 commits October 21, 2024 21:37
Collecting some feedback

---------

Co-authored-by: Lance Martin <[email protected]>
Consolidate the docs. After this, we'll need to potentially set up
redirect, and update links to existing llm pages.

Still not sure this is a good idea. May be better to rename the concept
page and redirect appropriately better, since we do still have string in
/ string out llm integrations
Update architecture page
* update concepts index page
* update callbacks
* add document loaders
* update architecture to not use links in section headings
@eyurtsev eyurtsev changed the title conceptual doc: re-organization (WIP) Docs: Re-organize conceptual docs Oct 22, 2024
Co-authored-by: Harrison Chase <[email protected]>
Add a few concepts that were missing
Adding more concepts
@eyurtsev eyurtsev marked this pull request as ready for review October 23, 2024 02:07
@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Oct 23, 2024
@eyurtsev eyurtsev merged commit f2dbf01 into master Oct 23, 2024
13 checks passed
@eyurtsev eyurtsev deleted the concept_docs branch October 23, 2024 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants