Skip to content

Update README with documentation for all project folders#27

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-ea7a7931-a2e8-4aee-b58a-c457af253e8c
Draft

Update README with documentation for all project folders#27
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-ea7a7931-a2e8-4aee-b58a-c457af253e8c

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 3, 2025

Updated the main README.md to include comprehensive documentation for all four project folders in the repository. The previous README was minimal and didn't describe what each folder contained, making it difficult for users to understand the available examples.

Changes Made

Added a new "Folders" section to the README that documents:

  • dns/ - Demonstrates DNS resolution issues with private endpoints and how to configure forwarding rules to resolve disconnected services
  • starhubspoke/ - Shows a Star/SnowFlake Hub-Spoke architecture example with centralized hub connecting multiple regional spokes
  • ase/ - Contains Azure App Service Environment (ASE v3) deployment with application gateway, bastion host, and private DNS
  • managedrunners/ - Sets up GitHub managed runners infrastructure with network peering and managed identity configuration

The descriptions provide clear context about what each folder demonstrates, helping users quickly identify which example fits their needs. For folders that already had README files (dns and starhubspoke), the descriptions are based on their existing documentation. For folders without READMEs (ase and managedrunners), the descriptions were inferred from analyzing the Bicep infrastructure code.

This improves the repository's usability by giving users an overview of all available Azure infrastructure examples in one place.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: h2floh <29010283+h2floh@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README with latest folder additions Update README with documentation for all project folders Sep 3, 2025
Copilot AI requested a review from h2floh September 3, 2025 13:38
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.

2 participants