Using Livebook for Elixir/Phoenix/LiveView documentation #1550
Replies: 2 comments
-
Hey @ChuckIrvine! We talked about the Elixir guides in the past, but they have a lot of oneline examples with the corresponding output, using the As for LiveView, it requires a mix project and even getting started would cover multiple files, so it doesn't fit Livebook that well. While it should be possible to define and start the whole LV application inside a Livebook, a getting started generally goes through small snippet changes applied to the app. In the future we may have a better integration with LV, such that we can define and render components/LVs in isolation. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
I've just become aware of Livebook and I wonder if the following idea has any merit?
I wonder how feasible it would be to write Elixir, Phoenix or LiveView documentation using Livebook? For example, look at the numbered sections on the right side of the page of the Elixir documentation at https://elixir-lang.org/getting-started/introduction.html. Would it be feasible to write Livebooks for each of these sections?
Given that the referenced Elixir documentation is already quite good, a better place to do something like this might be for Phoenix LiveView. I say this because, as far as I know, there is no official "getting started" documentation suitable for programmers totally new to Phoenix LiveView.
The best "getting started" documentation for Phoenix LiveView that I know of is the video course at https://pragmaticstudio.com/courses/phoenix-liveview. It is excellent introductory material, but it is fairly out-of-date and somewhat pricey.
Beta Was this translation helpful? Give feedback.
All reactions