Skip to content

Conversation

@CamSoper
Copy link
Contributor

Revise agent guidelines for moving, renaming, or deleting files, including the creation of redirects.

@claude
Copy link
Contributor

claude bot commented Sep 22, 2025

Pull Request Review

This PR improves the file management guidelines in AGENTS.md by adding comprehensive instructions for handling moved, renamed, or deleted files. The changes are well-structured and align with the repository's needs.

✅ Positive aspects:

  • Clear structure: The new "Moving and Deleting Files" section is well-organized and easy to follow
  • Comprehensive coverage: Addresses file history preservation, internal references, and redirect management
  • Practical guidance: Provides specific examples (e.g., neo-redirects.txt) and format specifications
  • Consistent formatting: Follows the existing style of the AGENTS.md file

✅ Technical accuracy:

  • The redirect format source-path|destination-url matches the existing files in /scripts/redirects/
  • The git mv recommendation for preserving file history is correct
  • The S3 redirects location is accurate

✅ Style compliance:

  • Uses semantic line breaks appropriately
  • Follows proper heading hierarchy (H2 level)
  • Uses consistent bullet point formatting
  • Maintains the established tone and style of the document

Minor observations:

The removal of the internal links rule from "Absolute Prohibitions" (line 46) appears intentional but wasn't mentioned in the PR description. This change makes sense as STYLE-GUIDE.md (lines 37-39) allows normal Markdown syntax for internal links, so the removed restriction was creating a conflict between agent and human guidelines.

Recommendation: ✅ APPROVE

This PR enhances the agent guidelines with practical, accurate instructions that will help maintain link integrity and proper file management practices. No changes needed.

@pulumi-bot
Copy link
Collaborator

AGENTS.md Outdated
## Moving and Deleting Files

- When moving, renaming, or deleting files, ensure all internal references are updated accordingly.
- When moving files within this repository, use `git mv` to preserve file history.
Copy link
Member

Choose a reason for hiding this comment

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

Note that this is not always possible, for example when breaking out a single document into multiple documents.

AGENTS.md Outdated

## Moving and Deleting Files

- When moving, renaming, or deleting files, ensure all internal references are updated accordingly.
Copy link
Member

Choose a reason for hiding this comment

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

This should be more specific:

  • We need to add an alias in the moved document.
  • I'm guessing we should ideally update links to use the new canonical path, but we do not enforce that today.
  • Anchors links do not support aliases. (I think. Need to test.) This comes up when splitting up long docs.
  • When can aliases be removed? (I don't know for sure, but I would guess when no other internal links refer to the old URI.)

AGENTS.md Outdated

- When moving, renaming, or deleting files, ensure all internal references are updated accordingly.
- When moving files within this repository, use `git mv` to preserve file history.
- Create redirects for any moved, renamed, or deleted files to maintain link integrity.
Copy link
Member

Choose a reason for hiding this comment

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

See above. "Alias" is the right term, because that's what it's called in the front matter.

@pulumi-bot
Copy link
Collaborator

@CamSoper CamSoper requested a review from jkodroff September 22, 2025 20:23
@CamSoper CamSoper merged commit c7cc630 into master Sep 22, 2025
8 checks passed
@CamSoper CamSoper deleted the agent-tweaks branch September 22, 2025 20:45
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.

3 participants