Skip to content

docs: consolidate prerequisites into one canonical five-section guide#12175

Draft
brooke-hamilton wants to merge 2 commits into
brooke-hamilton/agentex-phase3from
brooke-hamilton-consolidate-prerequisites-doc
Draft

docs: consolidate prerequisites into one canonical five-section guide#12175
brooke-hamilton wants to merge 2 commits into
brooke-hamilton/agentex-phase3from
brooke-hamilton-consolidate-prerequisites-doc

Conversation

@brooke-hamilton

@brooke-hamilton brooke-hamilton commented Jun 19, 2026

Copy link
Copy Markdown
Member

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.md the single canonical source of truth for setting up a Radius dev environment.

Merge target

⚠️ This PR targets the brooke-hamilton/agentex-phase3 plan branch, not main. 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 to main. The whole phase rolls up to main in a single follow-up PR after all Batch A PRs (and the PR 8/9 index work) land.

Scope

  • Canonical prerequisites doc — reformatted contributing-code-prerequisites/README.md into the standard Purpose → Prerequisites → Steps → Verification → Troubleshooting format. Every command, path, and make target was verified against the current repo (make build, make lint, make generate, pnpm -C typespec install, the go.mod tool directives for mockgen/controller-gen, the autorest/oav devDependencies, and the dev container lockfile workflow).
  • Codespaces restored — the previously commented-out GitHub Codespaces section is back with a corrected devcontainer_path (.devcontainer/devcontainer.json; the old path .devcontainer/contributor/devcontainer.json no longer exists). The repo ID and basicLinux32gb (8 GB) match the devcontainer's hostRequirements.
  • First-commit steps shrunk to linksfirst-commit-00-prerequisites and first-commit-01-development-tools now 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

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>
@brooke-hamilton brooke-hamilton requested review from a team as code owners June 19, 2026 21:37
@github-actions

github-actions Bot commented Jun 19, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread docs/contributing/contributing-code/contributing-code-prerequisites/README.md Outdated
Comment thread docs/contributing/contributing-code/contributing-code-prerequisites/README.md Outdated
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants