Skip to content

Docs: surface Codespaces / Dev Containers in README (follow-up to #27)#30

Merged
achandmsft merged 1 commit into
mainfrom
docs/codespaces-button
May 29, 2026
Merged

Docs: surface Codespaces / Dev Containers in README (follow-up to #27)#30
achandmsft merged 1 commit into
mainfrom
docs/codespaces-button

Conversation

@achandmsft
Copy link
Copy Markdown
Collaborator

Follow-up to #27 (dev container).

The dev container is in — make sure folks actually find it from the README:

  • Codespaces + Dev Containers badges under the short link at the top of the README, so the one-click try is the first thing visitors see after the title.
  • A blurb under the badges explaining what they get (preinstalled az, azd, Python 3.13) with a deep link to the new section.
  • Prerequisites now ends with "Or just open the repo in GitHub Codespaces / VS Code Dev Containers" — people who hit the "I don't want to install all that" reaction at the prerequisites list get an immediate out.
  • Quickstart has a one-liner pointing at the Codespaces variant.
  • New Quickstart in Codespaces subsection (just before Configuration) with the full four-step flow: badge → az login --use-device-code (required because the browser flow doesn't work the same inside a codespace) → azd env newazd up. Plus a note that the same dev container works locally via the Dev Containers extension.

No code changes — pure docs.

PR #27 added .devcontainer/devcontainer.json but didn't update the README. Add a top-of-readme badge row (GitHub Codespaces + VS Code Dev Containers), mention the dev container as a no-install alternative in Prerequisites, link to it from the Quickstart heading, and add a dedicated 'Quickstart in Codespaces' subsection with the full four-step flow (badge, az login --use-device-code, azd env new, azd up). Pure docs, no code changes.
@achandmsft achandmsft merged commit fe1dc13 into main May 29, 2026
5 checks passed
@achandmsft achandmsft deleted the docs/codespaces-button branch May 29, 2026 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant