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: integrations references update 7 #25217

Merged

Conversation

leo-gan
Copy link
Collaborator

@leo-gan leo-gan commented Aug 9, 2024

Added missed provider pages. Fixed formats and added descriptions and links.

Copy link

vercel bot commented Aug 9, 2024

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

Name Status Preview Comments Updated (UTC)
langchain ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 14, 2024 1:58pm

@leo-gan leo-gan marked this pull request as ready for review August 9, 2024 04:25
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Aug 9, 2024
@leo-gan leo-gan requested a review from ccurme August 12, 2024 20:34
@@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# ChatOctoAI\n",
"# Octo AI\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

admittedly this is inconsistent in the docs, but the template for chat models specifies a "Chat" prefix (see issue here: #22296)

Copy link
Collaborator Author

@leo-gan leo-gan Aug 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ccurme Change the template, please.
The integration example page is a document for humans. The page title should not be the names of classes, especially because the examples are not "example per class" pages. Integration examples are about the integrated System/Service/Package not about the integration implementation (hence not about classes/functions). We have API Ref that is exactly about the implementation.
The docs/integrations/ pages for the first-time readers who chose the best integration for the use case or learn how this integration works [in the most base use case].
The API Reference is for developers who work with real projects and need all internal details.

@dosubot dosubot bot added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Aug 14, 2024
@ccurme ccurme enabled auto-merge (squash) August 14, 2024 13:46
@ccurme ccurme merged commit 4a812e3 into langchain-ai:master Aug 14, 2024
13 checks passed
@leo-gan leo-gan deleted the docs-integrations-missed-references-fix-7 branch August 14, 2024 15:51
@leo-gan leo-gan changed the title docs: integrations references update docs: integrations references update 7 Aug 15, 2024
olgamurraft pushed a commit to olgamurraft/langchain that referenced this pull request Aug 16, 2024
Added missed provider pages. Fixed formats and added descriptions and
links.

---------

Co-authored-by: Chester Curme <[email protected]>
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 lgtm PR looks good. Use to confirm that a PR is ready for merging. size:L This PR changes 100-499 lines, ignoring generated files.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants