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: Redirect to api.js.langchain.com is wrong on Tools section #6504

Closed
2 tasks done
kevenleone opened this issue Aug 12, 2024 · 2 comments · Fixed by #6505
Closed
2 tasks done

DOC: Redirect to api.js.langchain.com is wrong on Tools section #6504

kevenleone opened this issue Aug 12, 2024 · 2 comments · Fixed by #6505
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder

Comments

@kevenleone
Copy link
Contributor

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:

The current doc: https://js.langchain.com/v0.2/docs/how_to/custom_tools/#tool-function

The link present on the text:

The tool wrapper function is a convenience method for turning a JavaScript function into a tool. It requires the function itself along with some additional arguments that define your tool. The most important are:

Is wrong

I was checking the doc and I found the following link: https://api.js.langchain.com/classes/langchain_core_tools.Tool.html instead of https://api.js.langchain.com/classes/langchain_core_tools.tool.html

Idea or request for content:

The redirect link is wrong

Copy link

dosubot bot commented Aug 12, 2024

Hey @kevenleone! I'm here to help you with any bugs, questions, or contributions you have. Let's tackle this issue together!

To address the issue with the incorrect link in the Tools section of the LangChain JS documentation, you need to update the link to point to the correct URL. The current link points to https://api.js.langchain.com/classes/langchain_core_tools.tool.html, but it should point to https://api.js.langchain.com/classes/langchain_core_tools.Tool.html.

Here are the steps to update the documentation:

  1. Locate the Documentation Source File:
    The source file for the Tools section is located at langchain/docs/modules/tools.md [1].

  2. Edit the Link:
    Open the tools.md file and find the incorrect link. Update it to the correct URL.

  3. Build and Serve the Documentation Locally:
    After making the changes, you can build and serve the documentation locally to verify the update:

    yarn build
    yarn dev
  4. Commit and Push the Changes:
    Once verified, commit the changes and push them to the repository.

By following these steps, you will ensure that the link in the Tools section correctly points to the Tool class documentation.

To continue talking to Dosu, mention @dosu.

@dosubot dosubot bot added the auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Aug 12, 2024
kevenleone added a commit to kevenleone/langchainjs that referenced this issue Aug 12, 2024
@bracesproul
Copy link
Collaborator

bracesproul commented Aug 12, 2024

Thank you for flagging this, will merge your PR asap!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants