Skip to content

Update README with comprehensive folder documentation and individual README files#26

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-25
Draft

Update README with comprehensive folder documentation and individual README files#26
Copilot wants to merge 2 commits into
mainfrom
copilot/fix-25

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 3, 2025

This PR addresses the need to document all folders in the repository by updating the main README.md and adding individual README files for folders that were missing documentation.

Changes Made

Main README.md Enhancement

  • Transformed the basic README into a comprehensive overview of all Azure Verified Modules examples
  • Added structured documentation for all four example folders with clear descriptions
  • Included getting started guide, prerequisites, and customization information
  • Applied consistent formatting with emojis and organized sections

New Individual README Files

Created detailed documentation for folders that were missing README files:

ase/README.md - Documents the App Service Environment v3 example including:

  • Complete network infrastructure setup
  • Virtual network with dedicated subnets
  • Application Gateway and Bastion Host configuration
  • Windows and Linux app service plans
  • Sample web applications with deployment slots

managedrunners/README.md - Documents the GitHub managed runners example including:

  • User Assigned Managed Identity with federated credentials
  • Key Vault integration with private endpoint access
  • Secure network architecture for GitHub Actions workflows
  • Cross-region network peering capabilities

Existing Documentation

Preserved existing README files for dns/ and starhubspoke/ folders which already had proper documentation.

Result

All four example folders now have comprehensive documentation that helps users understand:

  • The purpose and use case of each example
  • Key components and architecture patterns
  • How to deploy and customize the solutions

This makes the repository much more accessible for users looking to learn from and implement these Azure Verified Modules examples.

Fixes #25.


💬 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 comprehensive folder documentation and individual README files 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.

Update README with latest folder additions

2 participants