Phoenix_live_view: Visual Documentation for live views

[carlogilmar]

Hi! I'm was learning about Live Views for prepare a talk in the Mexico City Meetup, and I drew some illustrations about the documentation, and then I think that maybe it could be a contribution if the maintainers are agree with that, if is possible, I'll create the PR

The visual illustrations are this:

I create this from the documentation, so I think that maybe this kind of information could make this project more accesible. If you're agree I should know in which directory I could store the images and I'll generate the PR for be evaluated with more detail.

Thanks, Carlo. 🇲🇽

[josevalim]

We are not ready to make a decision on this yet but I just want to stop by and say thank you! Have a great talk!

[carlogilmar]

Thanks @josevalim ! This are the images that I drew based on the docs, maybe if there any feedback or recommendations I could fixing, I'd like to contribute with some kind of resources if there any possibility.

This are the slides that I made for the meetup, I think that this is a great way to be more clearly and accesible to share technical content.

Thanks, Carlo, 🇲🇽

[Skoda091]

@carlogilmar Was this talk recorded?

[carlogilmar]

@Skoda091 yes! https://youtu.be/vMkZ1QrE42Y?t=7787

[henrik]

I love the idea of visual documentation! I also worry that it could be harder to maintain as things change. Two ideas:

1. Link from the appropriate parts of the docs to this talk or to a blog post with these graphics.
2. Generate graphics from code (perhaps even making this part of ExDoc, or as an add-on) - though those would likely be simpler and have less personality.

[carlogilmar]

Sure! @henrik I've been working on how to create useful visual documentation to communicate better some complex concepts and for use as learning tools, recently I create this in a workshop of @whatyouhide

I'll be happy to collaborate with this kind of resources.