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: compact the API Reference links #21285

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

leo-gan
Copy link
Collaborator

@leo-gan leo-gan commented May 4, 2024

This PR is opinionated.
Issue: the API Reference sections in the examples hold too much vertical space and make us scroll the page too much. See an example. These sections are important. So, the compacting should not make these sections less noticeable.
Change: compacting the API Reference sections. See the same example after change applied. It is more compact and now looks like references (footnotes).
Note: I would also change the section style, so it would be more noticeable (maybe to look like the footnotes. Smaller wider font?)

Copy link

vercel bot commented May 4, 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 May 4, 2024 0:55am

@leo-gan leo-gan marked this pull request as ready for review May 4, 2024 01:13
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels May 4, 2024
@leo-gan leo-gan requested a review from baskaryan May 4, 2024 01:14
@leo-gan leo-gan requested a review from efriis May 17, 2024 16:37
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:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants