-
Couldn't load subscription status.
- Fork 255
Update agent guidelines for internal links and file management #16051
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Pull Request ReviewThis 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:
✅ Technical accuracy:
✅ Style compliance:
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: ✅ APPROVEThis PR enhances the agent guidelines with practical, accurate instructions that will help maintain link integrity and proper file management practices. No changes needed. |
|
Your site preview for commit badb0ec is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16051-badb0ec2.s3-website.us-west-2.amazonaws.com. |
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
…o and S3 redirect instructions
|
Your site preview for commit c647623 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16051-c6476237.s3-website.us-west-2.amazonaws.com. |
Revise agent guidelines for moving, renaming, or deleting files, including the creation of redirects.