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

DOC: Langchain API documentation "Next," "Previous," "Up" links are broken #21612

Open
2 tasks done
rpgoldman opened this issue May 13, 2024 · 1 comment
Open
2 tasks done
Assignees
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@rpgoldman
Copy link

Checklist

  • I added a very descriptive title to this issue.
  • I included a link to the documentation page I am referring to (if applicable).

Issue with current documentation:

Here's an example page that has this flaw: https://api.python.langchain.com/en/latest/langchain_api_reference.html#

So far every langchain API documentation page I have looked at is broken in this way.

Looking at the source code, this seems to be because those buttons are all disabled!

<div class="btn-group w-100 mb-2" role="group" aria-label="rellinks">
            <a href="[#](view-source:https://api.python.langchain.com/en/latest/langchain_api_reference.html#)" role="button" class="btn sk-btn-rellink py-1 disabled"">Prev</a>
            <a href="[#](view-source:https://api.python.langchain.com/en/latest/langchain_api_reference.html#)" role="button" class="btn sk-btn-rellink disabled py-1">Up</a>
            <a href="[#](view-source:https://api.python.langchain.com/en/latest/langchain_api_reference.html#)" role="button" class="btn sk-btn-rellink py-1 disabled"">Next</a>
        </div>

I'd suggest either:

  1. these buttons be made to work (no idea why they don't, but those hyperlinks look hinky -- shouldn't they link to other pages?) or
  2. these buttons be stripped out of the pages

Right now these links just create confusion for the reader,

Idea or request for content:

No response

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label May 13, 2024
@eyurtsev
Copy link
Collaborator

@baskaryan

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
Projects
None yet
Development

No branches or pull requests

3 participants