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: fix broken link #457

Closed
wants to merge 1 commit into from

Conversation

jannikmaierhoefer
Copy link

@jannikmaierhoefer jannikmaierhoefer commented Nov 19, 2024

Hi @hassiebp, this link was broken. Not quite sure why because it looked right. This change should work - lgfy?


Important

Fix broken link for langfuse-vercel package in README.md.

  • Documentation:
    • Fix broken link for langfuse-vercel package in README.md from ./langfuse-vercel to /modules/langfuse_vercel.html.

This description was created by Ellipsis for 8c8ba00. It will automatically update as commits are pushed.

Copy link

vercel bot commented Nov 19, 2024

@jannikmaierhoefer is attempting to deploy a commit to the langfuse Team on Vercel.

A member of the Team first needs to authorize it.

@@ -20,7 +20,7 @@ Modular mono repo for the Langfuse JS/TS client libraries.
| [langfuse](./langfuse) | [![npm package](https://img.shields.io/npm/v/langfuse?style=flat-square)](https://www.npmjs.com/package/langfuse) | Node >= 18, Web, Edge |
| [langfuse-node](./langfuse-node) | [![npm package](https://img.shields.io/npm/v/langfuse-node?style=flat-square)](https://www.npmjs.com/package/langfuse-node) | Node < 18 |
| [langfuse-langchain](./langfuse-langchain) | [![npm package](https://img.shields.io/npm/v/langfuse-langchain?style=flat-square)](https://www.npmjs.com/package/langfuse-langchain) | Node >= 20, Web, Edge |
| [langfuse-vercel (beta)](./langfuse-vercel) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |
| [langfuse-vercel (beta)](/modules/langfuse_vercel.html) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |
Copy link
Contributor

Choose a reason for hiding this comment

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

The link to langfuse-vercel (beta) was changed from a relative path to an absolute path. This is inconsistent with the other package links which use relative paths. Consider reverting to a relative path for consistency unless there's a specific reason for this change.

Suggested change
| [langfuse-vercel (beta)](/modules/langfuse_vercel.html) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |
| [langfuse-vercel (beta)](./modules/langfuse_vercel.html) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Disclaimer: Experimental PR review

PR Summary

Fixed broken link in README.md for the langfuse-vercel package documentation by changing from relative to absolute path.

  • Changed link from ./langfuse-vercel to /modules/langfuse_vercel.html in /README.md package table
  • New absolute path /modules/langfuse_vercel.html needs verification as it may not match repository structure
  • Consider using relative path to langfuse-vercel/README.md for consistency with other package links

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

@@ -20,7 +20,7 @@ Modular mono repo for the Langfuse JS/TS client libraries.
| [langfuse](./langfuse) | [![npm package](https://img.shields.io/npm/v/langfuse?style=flat-square)](https://www.npmjs.com/package/langfuse) | Node >= 18, Web, Edge |
| [langfuse-node](./langfuse-node) | [![npm package](https://img.shields.io/npm/v/langfuse-node?style=flat-square)](https://www.npmjs.com/package/langfuse-node) | Node < 18 |
| [langfuse-langchain](./langfuse-langchain) | [![npm package](https://img.shields.io/npm/v/langfuse-langchain?style=flat-square)](https://www.npmjs.com/package/langfuse-langchain) | Node >= 20, Web, Edge |
| [langfuse-vercel (beta)](./langfuse-vercel) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |
| [langfuse-vercel (beta)](/modules/langfuse_vercel.html) | [![npm package](https://img.shields.io/npm/v/langfuse-vercel?style=flat-square)](https://www.npmjs.com/package/langfuse-vercel) | Node >= 20, Web, Edge |
Copy link

Choose a reason for hiding this comment

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

logic: The absolute path '/modules/langfuse_vercel.html' may not be correct. Consider using a full URL to the documentation site or keeping it as a relative link to the repository directory if it exists.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant