Skip to content

docs: Revise documentation section in README.md#18

Merged
mvhenten merged 2 commits intomainfrom
fix-readme
Aug 27, 2025
Merged

docs: Revise documentation section in README.md#18
mvhenten merged 2 commits intomainfrom
fix-readme

Conversation

@mvhenten
Copy link
Owner

The pulling the example implementation up in the README because that's what people need.

The pulling the example implementation up in the README because that's what people need.
Copilot AI review requested due to automatic review settings August 27, 2025 11:26
Copy link
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

This PR restructures the README.md documentation by moving the example implementation before the detailed documentation section. The change prioritizes showing users practical usage before diving into technical decorator definitions.

  • Moved the detailed documentation section from before the example to after it
  • Added a brief explanation about the extension being driven by TypeSpec type definitions
  • Removed the full decorator code documentation from the top of the README

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@mvhenten mvhenten merged commit 53dfe49 into main Aug 27, 2025
3 checks passed
@mvhenten mvhenten deleted the fix-readme branch August 27, 2025 11:28
@github-actions
Copy link

github-actions bot commented Dec 3, 2025

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants