Update Swashbuckle documentation #32576
Conversation
- Remove unsupported notice for .NET 8. - Update package version numbers. - Remove reference to resolved issue. Resolves domaindrivendev/Swashbuckle.AspNetCore#2857.
|
Looks good overall! Do you mind also updating the references to Swashbuckle.AspNetCore versions elsewhere in the docs? I'm thinking specifically about 8.x samples that reference 6.5.x (see here)? |
|
Sure - I'll take a look - it didn't occur to me to look elsewhere in the docs 馃槃 |
Update additional example commands.
|
@captainsafia I did a quick look, and most of the remaining references are all package versions in the samples. A lot of those depend on pre-release versions of .NET from when the content was originally authored, so I figured trying to update those too would snowball fast into a whole world of pain 馃槄 |
No problem. I think we can do a selective look into which need updating separately. I think the fact that the version number is updating in the new doc is most important. |
|
Why even specify package version numbers in the docs? You recently updated the Swashbuckle.AspNetCore readme file and remove the explicit version numbers. Wouldn't the same make sense for the docs? Then it would always be current. |
|
What we do in our docs is different to what Microsoft do in their docs - I just did the minimal change which is to bump them, rather than question why they specified a version in the first place. Removing them entirely is a separate conversation. |
We manage docs for multiple versions of .NET in the Microsoft docs page. Providing specific package versions in each docs page allows us to maintain more high quality docs when package versions might differ across TFMs for example. This is especially important for communicating what version of Swashbuckle.AspNetCore works with .NET 8. |
Resolves domaindrivendev/Swashbuckle.AspNetCore#2857.
See #32477 (comment).
/cc @captainsafia
Internal previews