Skip to content

Conversation

fanruisun
Copy link
Contributor

@fanruisun fanruisun commented Aug 4, 2025

Description

Task link: Task 4202051: [Email][API doc][Java] Update the api doc page

Api doc page: https://learn.microsoft.com/en-us/java/api/overview/azure/communication-email-readme

  1. Remove the specific version and add a generic version https://learn.microsoft.com/en-us/java/api/overview/azure/communication-email-readme?view=azure-java-stable#include-direct-dependency example
  2. Add details in key Concepts section as it's empty
image

@Copilot Copilot AI review requested due to automatic review settings August 4, 2025 00:46
@fanruisun fanruisun requested review from kagbakpem and a team as code owners August 4, 2025 00:46
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README.md documentation for the Azure Communication Email library to address version management and content clarity issues. The changes remove hardcoded version numbers and eliminate empty documentation sections.

  • Updates version update markers to use dependency placeholders instead of hardcoded versions
  • Removes the hardcoded version number from the Maven dependency example
  • Eliminates the empty "Key concepts" section that provided no value to users

@fanruisun fanruisun enabled auto-merge (squash) August 9, 2025 00:32
@fanruisun fanruisun disabled auto-merge August 13, 2025 20:39
@fanruisun fanruisun changed the title edit version and remove key elements edit version and add key elements Aug 13, 2025
@fanruisun fanruisun merged commit b1d7a02 into Azure:main Aug 13, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants