Skip to content

Improve formatting and clarity in API documentation#128428

Open
minvoker wants to merge 2 commits intoMicrosoftDocs:mainfrom
minvoker:patch-2
Open

Improve formatting and clarity in API documentation#128428
minvoker wants to merge 2 commits intoMicrosoftDocs:mainfrom
minvoker:patch-2

Conversation

@minvoker
Copy link
Copy Markdown
Contributor

Changes include:

  • Fix file tree formatting for improved readability
  • Standardize JavaScript code formatting across examples
  • Correct grammar and phrasing in multiple sections
  • Improve clarity of configuration notes

@minvoker
Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree

@prmerger-automator
Copy link
Copy Markdown
Contributor

@minvoker : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit a315a01:

✅ Validation status: passed

File Status Preview URL Details
articles/static-web-apps/add-api.md ✅Succeeded

For more details, please refer to the build report.

@v-regandowner
Copy link
Copy Markdown
Contributor

@cjk7989

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator Bot added the aq-pr-triaged tracking label for the PR review team label Apr 21, 2026
@v-regandowner v-regandowner requested a review from Copilot April 21, 2026 13:54
Copy link
Copy Markdown
Contributor

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

Note

Copilot was unable to run its full agentic suite in this review.

Improves the readability and clarity of the Static Web Apps “add API” documentation by fixing formatting in the file tree example and tightening phrasing/grammar in several instructional notes.

Changes:

  • Fixes file tree indentation/structure under the api folder example.
  • Improves grammar and consistency (hyphenation, phrasing) in step instructions and notes.
  • Clarifies the GitHub Actions configuration note about framework-dependent values.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread articles/static-web-apps/add-api.md Outdated
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 4d3b7d4:

✅ Validation status: passed

File Status Preview URL Details
articles/static-web-apps/add-api.md ✅Succeeded

For more details, please refer to the build report.

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