elixir-omg icon indicating copy to clipboard operation
elixir-omg copied to clipboard

Provide a hints for developers how to experiment with codebase

Open pnowosie opened this issue 5 years ago • 3 comments

pnowosie avatar Oct 28 '19 08:10 pnowosie

Is this still relevant?

InoMurko avatar Nov 01 '19 11:11 InoMurko

@InoMurko edited the title. Thinking of a small doc that will show how to fearlessly kick iex off and play with code but leveraging all the goodness we developed since manual startup was the only way. Maybe it ends up to highlight some of the commands we have in the Makefile. Also our demos hang in the vain as they’re based on removed manual startup doc.

I’m open to suggestions

pnowosie avatar Nov 01 '19 17:11 pnowosie

I would propose the following: Delete the demo docs Rewrite the demos as tasks https://hexdocs.pm/mix/v1.9/Mix.Task.html where moduledoc becomes the documentation

InoMurko avatar Nov 01 '19 17:11 InoMurko