JoeyMckenzie
Add documentation
I can give this a try. Are you looking for C# docstrings or code walkthrough of some kind in markdown?
Docs are more what I was thinking, but there's always room for improvement on the READMEs (adding one to the services folder, store folder, etc.). This is a great one to tackle if you're looking to jump in, as I'm sure you'll find a few places we could definitely improve the code.
I can start by outlining the project folder structure and describing the code flow given an action dispatched in the UI.
If you have some other project in mind that's close (in structure or style) to what you are looking for, let me know.
Any pointers are welcome :)
On Tue, 8 Sep 2020, 8:51 pm Joey Mckenzie, [email protected] wrote:
Docs are more what I was thinking, but there's always room for improvement on the READMEs (adding one to the services folder, store folder, etc.). This is a great one to tackle if you're looking to jump in, as I'm sure you'll find a few places we could definitely improve the code.
— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/JoeyMckenzie/BlazorConduit/issues/2#issuecomment-688950124, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFFHD3TVCGMIWKGUAHDXIDSEZDWHANCNFSM4OLLTLKA .
I have put some details on https://github.com/shashwatsingh/BlazorConduit/wiki. In future if we plan to move to something like https://dotnet.github.io/docfx/index.html it would not be difficult to move these markdown pages.
I plan to take one interaction: like loading the home page, and go over the code flow. For example:
Index page event handler fired ⇒ ArticleList component loaded ⇒ Service Facade / Action dispatched ⇒ Effect ...
Please let me know if I should continue in this direction or would you recommend something else.
I have added https://github.com/shashwatsingh/BlazorConduit/wiki/Code-flow
Please let me know if I should continue along these lines.