Skip to content

Commit 29d181c

Browse files
docs: Add sections for Features, Getting Started, Guidance, and Resources in README.
1 parent e9891d7 commit 29d181c

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,42 @@ The Modernize your code solution accelerator allows users to specify a group of
99

1010
<div align="center">
1111

12-
[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
12+
[**FEATURES**](#features) \| [**GETTING STARTED**](#getting-started) \| [**GUIDANCE**](#guidance) \| [**RESOURCES**](#resources) \| [**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
1313

1414
</div>
1515
<br/>
1616

1717
**Note:** With any AI solutions you create using these templates, you are responsible for assessing all associated risks and for complying with all applicable laws and safety standards. Learn more in the transparency documents for [Agent Service](https://learn.microsoft.com/en-us/azure/ai-foundry/responsible-ai/agents/transparency-note) and [Agent Framework](https://github.com/microsoft/agent-framework/blob/main/TRANSPARENCY_FAQ.md).
1818
<br/>
1919

20+
## Features
21+
22+
- **Code language modernization** to help translate legacy SQL workloads into modern target dialects.
23+
- **Business logic analysis** to recover intent from older systems and limited documentation.
24+
- **Human-in-the-loop review** to summarize outputs and support validation before export.
25+
- **Multi-agent orchestration** using Azure AI Foundry and Azure OpenAI for scalable modernization workflows.
26+
27+
## Getting Started
28+
29+
1. Confirm you have an Azure subscription, the required permissions, and **Azure Developer CLI (`azd`) v1.18.0 or later**.
30+
2. Review the [Deployment Guide](./docs/DeploymentGuide.md) for the quickest path to deploy the solution.
31+
3. Run the [quota check guide](./docs/quota_check.md) before deployment to verify model capacity in your region.
32+
4. If you want to develop locally, follow the [Local Development Setup](./docs/LocalDevelopmentSetup.md) or [Local Setup Guide](./docs/LocalSetupGuide.md).
33+
34+
## Guidance
35+
36+
- Use the [Custom scenario guide](./docs/CustomizingScenario.md) to tailor the accelerator to your own modernization workflow.
37+
- Review the [WAF architecture guidance](./docs/ArchitectureWAF.md) if you need a Well-Architected deployment option.
38+
- Follow the [Azure Account Set Up](./docs/AzureAccountSetUp.md) instructions before deployment.
39+
- If you run into issues, check the [TroubleShootingSteps](./docs/TroubleShootingSteps.md) documentation.
40+
41+
## Resources
42+
43+
- [Azure AI Foundry documentation](https://learn.microsoft.com/en-us/azure/ai-studio/)
44+
- [Semantic Kernel Agent Framework](https://learn.microsoft.com/en-us/semantic-kernel/frameworks/agent/?pivots=programming-language-python)
45+
- [Azure OpenAI Service Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/use-your-data)
46+
- [AI Playbook](https://learn.microsoft.com/en-us/ai/playbook/)
47+
2048
<h2><img src="./docs/images/read_me/solution-overview.png" width="48" />
2149
Solution overview
2250
</h2>

0 commit comments

Comments
 (0)