search

chanan / BlazorStrap

Bootstrap 4 Components for Blazor Framework
https://blazorstrap.io
The Unlicense
910 stars 156 forks source link

Prerelease docs missing HTML #597

Open uecasm opened 1 year ago

uecasm commented 1 year ago

Looks like some omitted code quoting has caused some HTML to be stripped out of the release notes, rendering them indecipherable.

I was able to recover what I think was intended from the VNext docs page. (At least my test code seems to run ok.)

Although also the "in your layout put the BSCore" thing is probably at the wrong indent level, since that's not related to _Imports.razor. And I'm not sure showing an invalid integrity value like that is helpful -- or at least is less helpful than adding a paragraph with a link telling people when and how to get a real value to put there. (And it wouldn't be needed in a typical Blazor app, since it's in wwwroot.)

On a side note, I came looking for this update specifically due to some weird threading behaviour of BSModal in older versions (the Shown and Hidden events being called back not on the render thread, and various things returning before actually complete) -- I'm happy to say that the new preview (or actually Preview3, which seems to exist in NuGet but not GitHub Releases?) is behaving a lot more "sensibly" in these regards, though I've yet to test it in a larger app.

jbomhold3 commented 1 year ago

Thanks for the catch. Fixed the issue on the release notes and updated the wording. Also added preview 3 release notes.

jbomhold3 commented 1 year ago

For anyone reading this. Please keep in mind I'm doing this project in my free time. The release notes between the two sites can get out of sync. Nuget is the authority on things. Part of the reason they do get out of sync. Is me not want to spam people following this repo with micro fixes. For something as little as I made a human error in the last release and left a console.writeline in somewhere. But I will aim to get better at keeping important releases synced up with nuget.

uecasm commented 1 year ago

Thanks. I certainly didn't intend anything to be read in a negative way; I was just reporting a doc bug 😀

Regarding nuget vs github release notes, that's entirely reasonable especially with preview mini-releases. But I do find browsing the github release notes (or the commit history) more useful than the nuget ones, especially since the nuget doesn't list a "changelog", just a README that half the time only has the generic description. (And github is history scrollable while nuget is not.)

It's possible, though fiddly, to get nuget to show a changelog tab. I'm not suggesting that you actually do that, though; the github release notes are still a better experience.