Skip to content

[Agent Docs] Clean up AGENTS.md: fix stale reference, consolidate structure#8290

Merged
lucaspimentel merged 5 commits into
masterfrom
lpimentel/cleanup-agent-docs
Mar 17, 2026
Merged

[Agent Docs] Clean up AGENTS.md: fix stale reference, consolidate structure#8290
lucaspimentel merged 5 commits into
masterfrom
lpimentel/cleanup-agent-docs

Conversation

@lucaspimentel

@lucaspimentel lucaspimentel commented Mar 11, 2026

Copy link
Copy Markdown
Member

Summary of changes

Clean up AGENTS.md: fix a stale file reference, add missing components to the tracer directory list, and consolidate duplicated tracer structure sections.

Reason for change

  • docs/development/Serverless.md was renamed to AwsLambdaIntegrationTests.md in 02a29cf but the reference in AGENTS.md was not updated
  • Three components (AspNet, FaultTolerant, Generated) existed in the expandable details block but were missing from the main tracer directory list
  • The tracer structure was documented three times (bullet list, ASCII tree, component details) with significant overlap

Implementation details

  • Update stale Serverless.md reference to AwsLambdaIntegrationTests.md with corrected description
  • Add AspNet, FaultTolerant, Generated to the main component list
  • Remove redundant ASCII tree view from <details> block; retain only sub-structure breakdowns for the 8 most complex components (ClrProfiler, Agent, Configuration, Propagators, Telemetry, Debugger, Iast, DataStreamsMonitoring)
  • Net result: -96 lines, +14 lines

Test coverage

Documentation-only change — no functional code affected.

Other details

Also includes moving .claude/CLAUDE.md to project root. Although Claude Code will find corretly it in .claude/CLAUDE.md (and load the referenced AGENTS.md, it suggested that the repo root is easier to find and some tools may expected it there.

@lucaspimentel lucaspimentel changed the title Clean up AGENTS.md: fix stale reference, consolidate tracer structure [Docs] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 11, 2026
@lucaspimentel lucaspimentel changed the title [Docs] Clean up AGENTS.md: fix stale reference, consolidate structure [Docs] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 11, 2026
@lucaspimentel
lucaspimentel marked this pull request as ready for review March 11, 2026 19:21
@lucaspimentel
lucaspimentel requested a review from a team as a code owner March 11, 2026 19:21

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

See @../AGENTS.md

P2 Badge Fix AGENTS link to stay inside repository

After moving CLAUDE.md to the repo root, the file still points to @../AGENTS.md, which now resolves to /workspace/AGENTS.md instead of this repository’s /workspace/dd-trace-dotnet/AGENTS.md; in environments that resolve @ paths relative to the current file, Claude will fail to load the intended repo instructions and use incomplete guidance.

ℹ️ 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".

@dd-trace-dotnet-ci-bot

This comment was marked as off-topic.

@bouwkast bouwkast left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

👍

@lucaspimentel
lucaspimentel enabled auto-merge (squash) March 11, 2026 21:36
@dd-trace-dotnet-ci-bot

This comment was marked as off-topic.

@pr-commenter

This comment was marked as off-topic.

@lucaspimentel lucaspimentel changed the title [Docs] Clean up AGENTS.md: fix stale reference, consolidate structure [Agent Docs] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel lucaspimentel changed the title [Agent Docs] Clean up AGENTS.md: fix stale reference, consolidate structure [:robot: Agents] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel lucaspimentel changed the title [:robot: Agents] Clean up AGENTS.md: fix stale reference, consolidate structure [🤖 Agents] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel lucaspimentel changed the title [🤖 Agents] Clean up AGENTS.md: fix stale reference, consolidate structure [🤖] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel lucaspimentel changed the title [🤖] Clean up AGENTS.md: fix stale reference, consolidate structure [Agent Skill] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel lucaspimentel changed the title [Agent Skill] Clean up AGENTS.md: fix stale reference, consolidate structure [Agent Docs] Clean up AGENTS.md: fix stale reference, consolidate structure Mar 13, 2026
@lucaspimentel
lucaspimentel force-pushed the lpimentel/cleanup-agent-docs branch from 99a9773 to 5c274d7 Compare March 16, 2026 19:10
- Fix stale docs/development/Serverless.md reference (renamed to
  AwsLambdaIntegrationTests.md in 02a29cf)
- Add missing components (AspNet, FaultTolerant, Generated) to main
  tracer directory list
- Consolidate redundant <details> block: remove duplicate tree view,
  keep only sub-structure details for complex components

🤖 Co-Authored-By: Claude Code <[email protected]>
@lucaspimentel
lucaspimentel force-pushed the lpimentel/cleanup-agent-docs branch from 5c274d7 to 831d6ca Compare March 17, 2026 17:04
@lucaspimentel
lucaspimentel merged commit 79c1cd1 into master Mar 17, 2026
69 of 73 checks passed
@lucaspimentel
lucaspimentel deleted the lpimentel/cleanup-agent-docs branch March 17, 2026 19:58
@github-actions github-actions Bot added this to the vNext-v3 milestone Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants