docs: Please consider adding XML documentation for Fluent razor components about fast-blazor HOT 13 CLOSED

@EisenbergEffect Yup.

@vnbaaij 's namespace PR - > moving it to razor.cs - > xml docs!

from fast-blazor.

This sounds like a a great improvement. We'd love to have this as a community contribution 😄

from fast-blazor.

@EisenbergEffect Yes.
Can I know the place where we keep docs for FAST UI components so that I will try to match docs with their docs about each property and component so that it will be consistent for users!

from fast-blazor.

@ShreyasJejurkar
The official docs are here: https://docs.microsoft.com/en-us/fluent-ui/web-components/
The Fluent UI Web Components source is here: https://github.com/microsoft/fluentui/tree/master/packages/web-components. I would use the description fields from the xxx.vscode.definition.json files found in the web-components/src folder

from fast-blazor.

Thanks, @vnbaaij. I will start working on this one-by-one component this upcoming weekend.

from fast-blazor.

@ShreyasJejurkar, @EisenbergEffect Maybe we should use this opportunity to also move the c# code out of the .razor files and into .razor.cs files. We can leverage new VS2022 functionality to do this and then manually remove unnecessary using and use file scope namspace.
Once this is done, Shrejas can use the 'insert ///' to let VS insert summary blocks automatically. Makes adding the comments a lot easier.

from fast-blazor.

@vnbaaij Hmm. Yeh. That would be a good idea to have a separate file for code-behind .razor.cs. Right now the code is small so it's ok, but going forward it can be huge so better to go off with code-behind.
Am totally ok with that approach. 👍

from fast-blazor.

@vnbaaij In order to minimize conflicts, how do we want to order the PRs? Should we get the namespace/using PR in first, then the update to .razor.cs and then the update to the doc comments? I can probably get the namespace PR merged today. Thoughts?

from fast-blazor.

@EisenbergEffect If you canget #126 in first, I'll post another PR to move the code to separate files, update usings, etc in a bit (working on that rn)

from fast-blazor.

#126 is now merged 😄 (I really like the new using and namespace features.)

from fast-blazor.

@EisenbergEffect yup, that feature is quite good one!

from fast-blazor.

@EisenbergEffect #138 is ready for merging the changes mentioned above

from fast-blazor.

Closed with #188

from fast-blazor.