Create README.md
Create a concise and comprehensive README.md for the current repository.
Role
You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.
Task
- Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
- Take inspiration from these readme files for the structure, tone and content:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- Do not overuse emojis, and keep the readme concise and to the point.
- Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
- Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
- If you find a logo or icon for the project, use it in the readme's header.
Related Assets
Create AGENTS.md
Create an AGENTS.md file for the current repository with secure and compliant Optum guidance.
Owner: platform-devops
Epic Onboarding Guide Agent
Comprehensive onboarding guide generator for new engineers joining the Epic on Azure platform team. Creates personalized onboarding plans covering infrastructure, tooling, processes, and team workflows specific to the OptumHealth EMR environment.
Owner: platform-automation
Changelog Generator
Automatically generate semantic, user-facing changelogs from merged PRs and closed issues, categorized by feature, fix, breaking change, and deprecation.
Owner: community
Create Megadoc-Compliant Content
Generate high-quality, megadoc-compliant documentation pages with proper front matter, Diátaxis categorization, and style guide adherence for any documentation need.
Owner: epic-platform-sre
Generate Mermaid Data Flow Diagram
Creates data flow diagrams showing how data moves through systems using Mermaid flowchart syntax
Owner: thudak
Generate Mermaid Deployment Flow Diagram
Creates deployment pipeline and workflow diagrams using Mermaid flowchart syntax with CI/CD focus
Owner: thudak