docs: consolidate prerequisites into one canonical five-section guide#12175
Draft
brooke-hamilton wants to merge 2 commits into
Draft
docs: consolidate prerequisites into one canonical five-section guide#12175brooke-hamilton wants to merge 2 commits into
brooke-hamilton wants to merge 2 commits into
Conversation
Make contributing-code-prerequisites/README.md the single source of truth for dev-environment setup, reformatted into the standard Purpose -> Prerequisites -> Steps -> Verification -> Troubleshooting format. Restore the GitHub Codespaces section with a corrected devcontainer path (.devcontainer/devcontainer.json). Shrink the first-commit prerequisites and development-tools steps to a short intro plus links, and remove the manual 'keep in sync' notes. Every command, path, and make target verified against current code. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR (Batch A / PR 2 in the Agent Ex Phase 3 plan) refactors the Radius contributor onboarding docs so docs/contributing/contributing-code/contributing-code-prerequisites/README.md becomes the canonical, five-section (Purpose → Prerequisites → Steps → Verification → Troubleshooting) guide for dev-environment setup, and the “first commit” tutorial pages link back to it instead of duplicating setup content.
Changes:
- Rewrites the prerequisites guide into a single canonical setup doc covering Codespaces, VS Code dev containers, and local installs, with verification + troubleshooting.
- Restores and corrects the GitHub Codespaces button/link (devcontainer path updated to
.devcontainer/devcontainer.json). - Shrinks the first-commit prerequisites + tools pages to short intros with links back to the canonical prerequisites sections.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/contributing/contributing-code/contributing-code-prerequisites/README.md | Converts prerequisites into a canonical five-section guide and adds verification/troubleshooting plus devcontainer lockfile maintenance guidance. |
| docs/contributing/contributing-code/contributing-code-first-commit/first-commit-01-development-tools/index.md | Removes duplicated editor/tooling setup instructions and links to the canonical prerequisites doc instead. |
| docs/contributing/contributing-code/contributing-code-first-commit/first-commit-00-prerequisites/index.md | Replaces duplicated prerequisite instructions with links to the canonical prerequisites doc and container-based setup entry points. |
Fix the relative links from the first-commit prerequisites and development-tools pages to the canonical prerequisites guide (../ -> ../../, reaching the sibling contributing-code-prerequisites folder; the single-dot-dot form was a pre-existing broken link). Add a Corepack/pnpm enablement note before 'pnpm -C typespec install' for the local-install path, and soften Docker from a required core dependency to one needed only for container image builds or the dev container. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Brooke Hamilton <45323234+brooke-hamilton@users.noreply.github.com>
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
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.
Summary
This is PR 2 (Prerequisites / dev environment) of the Agent Ex — Phase 3 (Contributing docs) plan — see the PR 2 task under §6 of that plan. It makes
contributing-code-prerequisites/README.mdthe single canonical source of truth for setting up a Radius dev environment.Merge target
brooke-hamilton/agentex-phase3plan branch, notmain. It is one of seven stacked Batch A PRs; approving and merging it lands the change on the plan branch only — it does not merge anything tomain. The whole phase rolls up tomainin a single follow-up PR after all Batch A PRs (and the PR 8/9 index work) land.Scope
contributing-code-prerequisites/README.mdinto the standard Purpose → Prerequisites → Steps → Verification → Troubleshooting format. Every command, path, andmaketarget was verified against the current repo (make build,make lint,make generate,pnpm -C typespec install, thego.modtool directives formockgen/controller-gen, theautorest/oavdevDependencies, and the dev container lockfile workflow).devcontainer_path(.devcontainer/devcontainer.json; the old path.devcontainer/contributor/devcontainer.jsonno longer exists). The repo ID andbasicLinux32gb(8 GB) match the devcontainer'shostRequirements.first-commit-00-prerequisitesandfirst-commit-01-development-toolsnow carry a short intro plus links to the canonical doc, and the manual "keep in sync" notes are removed. Co-located tutorial content (Launching VS Code, Related links) is preserved.The planning docs under
specs/002-agent-ex/were not modified.Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com