-
Notifications
You must be signed in to change notification settings - Fork 258
Enhance project file documentation for infra Pulumi YAML #16676
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
Fixes #16674 Expanded explanation of the project file's role in Pulumi YAML programs by adding details about top-level attributes.
Documentation ReviewI've reviewed the changes in this PR. The enhancement adds helpful context about Pulumi YAML's top-level attributes ( ✅ Strengths
📝 SuggestionsLine 25: Consider rewording for better clarity The phrase "top-level attributes related to infrastructure" could be more precise. Consider: Rationale:
SummaryThe change is technically accurate and improves discoverability. The minor wording suggestion above is optional but would improve precision and clarity. If you'd like me to apply the suggested changes or perform additional reviews, mention me (@claude) in a comment. |
|
Your site preview for commit b0e24cc is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16676-b0e24ccf.s3-website.us-west-2.amazonaws.com. |
|
@claude apply the suggested changes |
|
Claude finished @pose's task —— View job Applying Suggested ChangesI've successfully applied the wording improvements from my previous review. Tasks
Changes MadeUpdated line 25 in
These changes improve technical accuracy (the YAML spec refers to them as properties) and make the description more direct and clear. --- | |
Changed "top-level attributes related to infrastructure" to "top-level properties that define your infrastructure" for better technical accuracy and clarity. Co-authored-by: Alberto Pose <pose@users.noreply.github.com>
|
Your site preview for commit 61a3495 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16676-61a34951.s3-website.us-west-2.amazonaws.com. |
Fixes #16674
Expanded explanation of the project file's role in Pulumi YAML programs by adding details about top-level attributes. For example, this should make easier to discover where to find documentation for the
resourcesproperty.