Tidy example READMEs and document conventions - #2998
Merged
Conversation
Reshapes every example's README to a consistent, type-appropriate structure (deployable, non-deployable, and multi-project index), adds template blocks so the deploy button works on all deployable examples, applies sentence-case headings per the brand guidelines, and matches prerequisites and install steps to each project's runtime. Also updates CONTRIBUTING.md, the README template, and AGENTS.md to document the standard. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
cnunciato
changed the title
cnunciato
marked this pull request as ready for review
September 7, 2026 13:43
cnunciato
changed the title
Points all Install Pulumi, language, and Docker prerequisite links at a single canonical URL each, lowercases the credentials link text for sentence-case consistency, and records the canonical prerequisite links in AGENTS.md and the README template. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
jkodroff
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates all READMEs to align with a consistent, type-appropriate structure (deployable, non-deployable, and multi-project index), adds
template:blocks so the deploy button works on all deployable examples, applies sentence-case headings per the brand guidelines, and matches prerequisites and install steps to each project's runtime. Also updates CONTRIBUTING.md, the README template, and AGENTS.md to document the conventions.