Skip to content

docs: use AGENTS.md as root instruction source#1669

Closed
lyzno1 wants to merge 1 commit into
voidzero-dev:mainfrom
lyzno1:codex/root-agents-source
Closed

docs: use AGENTS.md as root instruction source#1669
lyzno1 wants to merge 1 commit into
voidzero-dev:mainfrom
lyzno1:codex/root-agents-source

Conversation

@lyzno1
Copy link
Copy Markdown
Contributor

@lyzno1 lyzno1 commented May 24, 2026

Summary

  • add root AGENTS.md as the canonical agent instruction file
  • replace root CLAUDE.md with a symlink to AGENTS.md

Testing

  • not run; documentation-only change

@netlify
Copy link
Copy Markdown

netlify Bot commented May 24, 2026

Deploy Preview for viteplus-preview canceled.

Name Link
🔨 Latest commit 4a06cec
🔍 Latest deploy log https://app.netlify.com/projects/viteplus-preview/deploys/6a12cd68c78c36000859af9b

@chatgpt-codex-connector
Copy link
Copy Markdown

💡 Codex Review

AGENTS.md

P2 Badge Keep CLAUDE.md as a regular file for cross-platform checkouts

Replacing CLAUDE.md with a symlink can break instruction discovery on environments where Git checks out symlinks as plain files (for example when core.symlinks=false, common on Windows), because CLAUDE.md then contains only the literal text AGENTS.md instead of the instruction content. Any tooling that still reads CLAUDE.md directly will lose all repository guidance in that setup, so this introduces a compatibility regression for contributors and automation on those platforms.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@fengmk2
Copy link
Copy Markdown
Member

fengmk2 commented May 24, 2026

Duplicated with #1670

@fengmk2 fengmk2 closed this May 24, 2026
@lyzno1 lyzno1 deleted the codex/root-agents-source branch May 24, 2026 12:09
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.

2 participants