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/providers/More #28071

Closed

Conversation

leo-gan
Copy link
Collaborator

@leo-gan leo-gan commented Nov 13, 2024

The current integration/providers/all page is not readable. It has too many items.
I've generated it with A-Z menu. Now it is much easier to navigate.
See the result page.

Copy link

vercel bot commented Nov 13, 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 Dec 12, 2024 1:16am

@leo-gan
Copy link
Collaborator Author

leo-gan commented Nov 13, 2024

@efriis Hey Erick, can you, please, check the Vercel error? I've added a page generation script to Makefile but it doesn't work and I cannot localize the problem, since I cannot reproduce the Vercel workflow locally.

@leo-gan leo-gan marked this pull request as ready for review November 13, 2024 01:53
@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 Nov 13, 2024
@leo-gan leo-gan changed the title docs: integrations providers index docs: integrations/providers/More Nov 13, 2024
@efriis
Copy link
Member

efriis commented Dec 5, 2024

@leo-gan you can look at the vercel errors yourself now I think! does this link (the details on the vercel failure) work for you?

Copy link
Member

Choose a reason for hiding this comment

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

completely understand sometimes scripts are the best way to do things, but scripts like this are quite difficult to maintain long-term.

In this particular case, I think it would be better to do this as a mdx component that iterates through the sidebar data to achieve the same end

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK I'll try to do it as an mdx component. Thanks for the feedback, Erick!

@efriis efriis self-assigned this Dec 5, 2024
@efriis
Copy link
Member

efriis commented Dec 10, 2024

great thank you! Feel free to mark ready to review at that point

@leo-gan
Copy link
Collaborator Author

leo-gan commented Dec 10, 2024

@efriis
It looks nice , hehe
I've tried to implement the page-generation logic as the .mdx component. It was not simpler than the current implementation. So, I fallback here.
Now, it is a direct page generation.

@leo-gan leo-gan marked this pull request as ready for review December 10, 2024 23:49
@leo-gan leo-gan requested a review from efriis December 10, 2024 23:58
@efriis
Copy link
Member

efriis commented Dec 12, 2024

got it. I actually prefer the current to the preview https://langchain-git-fork-leo-gan-docs-integrations-p-2e3492-langchain.vercel.app/docs/integrations/providers/all/

so i will close it. one way that could be interesting to resolve this is to see if there are any other docusaurus plugins/themes that handle the "page listing" component nicely

@efriis efriis closed this Dec 12, 2024
@leo-gan leo-gan deleted the docs-integrations-providers-index branch December 12, 2024 02:54
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: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