search

rundis / elm-bootstrap.info

User documentation for Elm Bootstrap
BSD 3-Clause "New" or "Revised" License
11 stars 19 forks source link

Make all examples editable (via Ellie?) #4

Open brasilikum opened 7 years ago

brasilikum commented 7 years ago

The title says it all. What do you think about it, @rundis?

If you like the idea, I could look into the details of it and submit a pull request

rundis commented 7 years ago

I'd love to and I thought about it, here's why I ended up not doing it (for now at least);

1) Release chicken and Egg issue To write examples in Ellie and test them, elm-bootstrap have to be released to the package repo (otherwise Ellie will not be able to see the newest stuff obviously). That means I can't do like I can now, namely write examples for not yet released stuff and update the doc site in sync with elm-bootstrap releases. 2) Maintenance - It's arguably quite a bit more maintenance to manually edit a ton of Ellie examples through a web browser with a editor that has very limited capabilities. Using a proper editor I can both get help from the compiler and do search/replace fixes accross a bunch of files. If Ellie supported an api for creating/updating examples things would be easier. Talked to Luke about it, but there are some issues that needs to be resolved for that to be possible. It's on the feature request list though.

So as much as I'd love to do it, I need to feel comfortable with maintaining it too. And currently I can't see a nice solution that gives ellie the edge as a general purpose solution.

brasilikum commented 7 years ago

Ok, thanks for the extensive explanation. I get your points. A hack for 1. could be to publish a special "preview" package. But I get that this might not be desirable.