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.

Sign up for GitHub

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

Jump to bottom

Add detailed documentation to source #27

Open
jackiryan opened this issue Mar 18, 2019 · 0 comments
Open

Add detailed documentation to source #27

jackiryan opened this issue Mar 18, 2019 · 0 comments
Assignees
@jackiryan
Labels
doc only Does not require writing lines of code good first issue Good for newcomers
Projects
Winter/Spring 2019 Goals
Milestone
Pre-summer 2019

Comments

@jackiryan
Copy link
Collaborator

This is an embarrassing one, but yes, the source is criminally under-documented. Additionally, this would be a great time to add in a flow chart or cartoon illustrating the way the different components of LiveView work together. I am a visual person, and I find it helps to use drawings to visually the many parallel components of the software.

This issue will be sticking around for a while.
@jackiryan jackiryan added good first issue Good for newcomers doc only Does not require writing lines of code labels Mar 18, 2019
@jackiryan jackiryan added this to the Pre-summer 2019 milestone Mar 18, 2019
@jackiryan jackiryan self-assigned this Mar 18, 2019
@jackiryan jackiryan added this to To do in Winter/Spring 2019 Goals via automation Mar 18, 2019
@jackiryan jackiryan moved this from To do to In progress in Winter/Spring 2019 Goals Mar 21, 2019
@jackiryan jackiryan moved this from In progress to To do in Winter/Spring 2019 Goals Mar 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc only Does not require writing lines of code good first issue Good for newcomers
1 participant
@jackiryan