Closed
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md file by adding a new "Important" section with a brief note. The change appears to supplement the existing important notice about the project's maintenance status.
- Adds a new "Important" section to the README documentation
|
|
||
| ## Important | ||
|
|
||
| This is also important. |
There was a problem hiding this comment.
The content 'This is also important.' is vague and uninformative. Consider providing specific, actionable information that helps users understand what they need to know.
Suggested change
| This is also important. | |
| The `APIWeaver.OpenApi` library is a powerful tool for developers working with OpenAPI documents in .NET. |
Comment on lines
9
to
16
| > This project is currently **not actively maintained or developed**. For a maintained alternative with a similar feature set, consider [martincostello/openapi-extensions](https://github.com/martincostello/openapi-extensions). | ||
|
|
||
| ## Important | ||
|
|
||
| This is also important. | ||
|
|
||
| `APIWeaver.OpenApi` is a lightweight .NET 9 library that extends the OpenAPI document generated by .NET's built-in OpenAPI document generator. It’s compatible with native AOT and offers extension methods and transformers for flexible customization. | ||
|
|
There was a problem hiding this comment.
Adding a generic 'Important' section immediately after an existing IMPORTANT callout creates redundancy and confusion. Consider consolidating the information into the existing important notice or using a more specific heading.
Suggested change
| > This project is currently **not actively maintained or developed**. For a maintained alternative with a similar feature set, consider [martincostello/openapi-extensions](https://github.com/martincostello/openapi-extensions). | |
| ## Important | |
| This is also important. | |
| `APIWeaver.OpenApi` is a lightweight .NET 9 library that extends the OpenAPI document generated by .NET's built-in OpenAPI document generator. It’s compatible with native AOT and offers extension methods and transformers for flexible customization. | |
| > This project is currently **not actively maintained or developed**. For a maintained alternative with a similar feature set, consider [martincostello/openapi-extensions](https://github.com/martincostello/openapi-extensions). Additionally, `APIWeaver.OpenApi` is a lightweight .NET 9 library that extends the OpenAPI document generated by .NET's built-in OpenAPI document generator. It’s compatible with native AOT and offers extension methods and transformers for flexible customization. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.