Skip to content

Conversation

@finbarrtimbers
Copy link
Collaborator

@finbarrtimbers finbarrtimbers commented Nov 18, 2025

Summary

  • replace the previous pointer text with a symbolic link so CLAUDE.md resolves directly to AGENTS.md

Testing

  • make style (fails: unable to download torch==2.8.0+cu128 from download.pytorch.org due to tunnel error)
  • uv run pytest (fails: unable to download torch==2.8.0+cu128 from download.pytorch.org due to tunnel error)

Codex Task


Note

Move instructions into AGENTS.md and make CLAUDE.md a symlink-style pointer to it.

  • Docs:
    • AGENTS.md: Added developer commands and workflow guidelines (tests, lint/format, training launch scripts).
    • CLAUDE.md: Replaced full content with a symlink-style reference to AGENTS.md (removes duplicated instructions).

Written by Cursor Bugbot for commit 8545166. This will update automatically on new commits. Configure here.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @finbarrtimbers, I'm Gemini Code Assist1! 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!

This pull request streamlines the project's documentation by consolidating common development instructions. It replaces the content of CLAUDE.md with a new AGENTS.md file, which now holds the definitive set of Bash commands and workflow guidelines. Subsequently, CLAUDE.md is updated to simply point to AGENTS.md, effectively creating a symbolic link to prevent duplication and ensure that all references lead to the same, up-to-date information.

Highlights

  • Documentation Consolidation: The instructions previously duplicated in CLAUDE.md have been moved to a new, centralized AGENTS.md file.
  • Symbolic Link Creation: The CLAUDE.md file has been re-created to act as a symbolic reference (or pointer) to AGENTS.md, ensuring consistency and ease of updates.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request aims to replace CLAUDE.md with a symbolic link to a new AGENTS.md file, which now contains the development instructions. While the content has been successfully moved to AGENTS.md, the CLAUDE.md file is not a symbolic link but a plain text file containing the string "AGENTS.md". My review includes a suggestion to make CLAUDE.md a proper markdown file with a link to AGENTS.md for better usability. I've also included a minor suggestion to improve the clarity of a command description in AGENTS.md.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Bug: Incorrect file type breaks documentation content.

CLAUDE.md contains literal text "AGENTS.md" instead of being a symbolic link. The file is a regular text file, not a symlink, so reading CLAUDE.md returns unhelpful text rather than the actual documentation content from AGENTS.md. Symbolic links require creation via ln -s and show differently in git diffs (mode 120000).

CLAUDE.md#L1-L1

AGENTS.md

Fix in Cursor Fix in Web


Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Bug: CLAUDE.md: Wrong file type

CLAUDE.md is a text file containing "AGENTS.md" rather than an actual symbolic link. This means opening CLAUDE.md displays the text "AGENTS.md" instead of the agent instructions, breaking the intended functionality described in both the PR description and README.md that claims it's a symbolic link for backward compatibility with older tooling.

CLAUDE.md#L1-L1

AGENTS.md

Fix in Cursor Fix in Web


Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Bug: Documentation link is just a text file.

CLAUDE.md is a regular text file containing the string AGENTS.md rather than an actual symbolic link to AGENTS.md. This means opening CLAUDE.md displays only the text "AGENTS.md" instead of the intended documentation content. The file needs to be created as a filesystem symlink using ln -s rather than as a text file.

CLAUDE.md#L1-L1

AGENTS.md

Fix in Cursor Fix in Web


Copy link
Contributor

@saurabh111233212 saurabh111233212 left a comment

Choose a reason for hiding this comment

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

a great change for codex enjoyers like myself.

or maybe ur doing it for gemini 3? Lmao

@finbarrtimbers finbarrtimbers added this pull request to the merge queue Nov 18, 2025
Merged via the queue into main with commit 23d82eb Nov 18, 2025
4 checks passed
@finbarrtimbers finbarrtimbers deleted the codex/rename-claude.md-to-agents.md-and-add-claude.md branch November 18, 2025 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants