Update README.md

[SecroLoL]

📝 Summary

Update links to docs in the README from Mintlify to fumadocs

[gemini-code-assist]

Hello @SecroLoL, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello! Gemini here, providing a summary of this pull request. This PR, authored by SecroLoL, focuses on updating the documentation links within the README.md file. The primary goal, as indicated by the title and description, is to migrate the links from the previous Mintlify-hosted documentation to the new documentation hosted on docs.judgmentlabs.ai. This ensures users are directed to the correct and up-to-date documentation resources.

Highlights

• Documentation Link Update: All links pointing to the old Mintlify-hosted documentation (judgment.mintlify.app) have been updated to point to the new domain (docs.judgmentlabs.ai).
• README.md Changes: The changes are confined to the README.md file, specifically targeting various sections that reference the documentation, including the main docs link, setup guide, and specific guides for tracing, evaluations, and self-hosting.

Changelog

• README.md
  • Updated the main 'Docs' link in the header from judgment.mintlify.app/getting_started to docs.judgmentlabs.ai/introduction.
  • Updated the 'setup guide' link from judgment.mintlify.app/getting_started to docs.judgmentlabs.ai/getting-started.
  • Updated the link for the detailed explanation of creating the first trace from judgment.mintlify.app/getting_started#create-your-first-trace to docs.judgmentlabs.ai/getting-started#create-your-first-trace.
  • Updated the link for the detailed explanation of creating the first experiment from judgment.mintlify.app/getting_started#create-your-first-experiment to docs.judgmentlabs.ai/getting-started#create-your-first-experiment.
  • Updated the link for the detailed explanation of creating the first online evaluation from judgment.mintlify.app/getting_started#create-your-first-online-evaluation to docs.judgmentlabs.ai/getting-started#create-your-first-online-evaluation.
  • Updated the link for the self-hosting documentation from judgment.mintlify.app/self_hosting/get_started to docs.judgmentlabs.ai/self-hosting/get_started.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A link once led astray,
To docs from yesterday.
A new path is set,
No need to fret,
Find wisdom the modern way.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates documentation links in the README.md file, migrating them from the old Mintlify-based URLs to the new fumadocs-based URLs. The changes are mostly straightforward and align with the stated goal. Most link updates appear correct, with consistent domain changes and logical path/anchor adjustments. There's one specific path transformation that would be good to double-check for correctness with the new documentation system.

Summary of Findings

• Potential URL path mismatch for self-hosting docs: The self-hosting documentation link (line 177) was changed from a path including .../self_hosting/... to .../self-hosting/.... Based on the source file structure (docs/self_hosting/get_started.mdx), this transformation from underscore to hyphen in the directory part of the path should be verified against fumadocs' URL generation behavior. If this transformation is not standard or intended, the link might be broken. This is flagged as a medium severity issue in a review comment.
• Link text 'Click here': Several links use 'Click here' as anchor text (e.g., lines 96, 125, 165). For improved accessibility and SEO, consider using more descriptive link text in the future, such as 'View details on creating your first trace'. This was not commented on directly as it's pre-existing text, the PR focuses on URL updates, and it's considered low severity.
• Main 'Docs' link target page: The main 'Docs' link target was changed from /getting_started to /introduction (line 12). This is likely an intentional and appropriate change for a general documentation landing page, especially since docs/introduction.mdx exists. This was not commented on directly as it's likely correct and considered low severity.

Merge Readiness

The pull request makes necessary updates to documentation links. However, there is one medium severity concern regarding a specific URL path transformation for the self-hosting documentation (line 177) that needs verification to ensure the link is not broken. I recommend addressing or confirming this point before merging. As a reviewer, I am not authorized to approve pull requests, so please ensure further review and approval as per your team's process once the feedback is addressed.

[gemini-code-assist]

The link for 'self-hosting documentation' has been updated from .../self_hosting/get_started (with an underscore in self_hosting) to .../self-hosting/get_started (with a hyphen in self-hosting).

Given that the source file path for this documentation appears to be docs/self_hosting/get_started.mdx (based on the provided full file context), could you please confirm if fumadocs generates the URL path segment as self-hosting (with a hyphen) from a source directory named self_hosting (with an underscore)?

If fumadocs preserves underscores from directory names in the generated URL, or if the source directory is indeed self_hosting, then the path segment in the URL might need to be self_hosting/get_started to match.

Just want to ensure this link will resolve correctly in the new documentation system. Could you verify this specific path transformation?

[andrewli2403]

LGTM!