Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #2

Open
JoeyMckenzie opened this issue Jun 29, 2020 · 5 comments
Open

Add documentation #2

JoeyMckenzie opened this issue Jun 29, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@JoeyMckenzie
Copy link
Owner

Title, I seriously slacked on docs.

@JoeyMckenzie JoeyMckenzie added the documentation Improvements or additions to documentation label Jun 29, 2020
@shashwatsingh
Copy link

I can give this a try. Are you looking for C# docstrings or code walkthrough of some kind in markdown?

@JoeyMckenzie
Copy link
Owner Author

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.

@shashwatsingh
Copy link

shashwatsingh commented Sep 8, 2020 via email

@shashwatsingh
Copy link

shashwatsingh commented Sep 13, 2020

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.

@shashwatsingh
Copy link

I have added https://github.com/shashwatsingh/BlazorConduit/wiki/Code-flow

Please let me know if I should continue along these lines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants