mlr3book icon indicating copy to clipboard operation
mlr3book copied to clipboard

Add introductory section

Open jemus42 opened this issue 3 years ago • 2 comments

As a replacement for the Quickstart section, since the book website needs some kind of "landing page" and quarto requires an index.qmd to exist.

Some sort of foreword or acknowledgements were ideas that came up.

jemus42 avatar Sep 08 '22 09:09 jemus42

While a rewrite of the intro can always be done, I don't understand why the current quickstart was removed in favor of a placeholder? 3b1e6f74a873f4546ff568c3ddd0bfe931424c89

The current version looks odd and worse than before. Can we revert and wait for a proper PR to update the section?

pat-s avatar Sep 15 '22 17:09 pat-s

That's what I initially thought as well, maybe should ping Bernd about that again.

In any case, my initial remark that let to the admittedly hasty removal was that the Quickstart section felt a little out of place where other books have some sort of landing page, greeting, cover, acknowledgments etc. anyone have a favorite O'Reilly-like bird that's not taken already? 😬

jemus42 avatar Sep 15 '22 19:09 jemus42

I wouldn't stress about this now. We can have Title Page -> Preamble -> Introduction. The quickstart will become the preamble in the printed version and the title page will be based on the book, e.g. using this as an example. If you both agree I'll close this for now.

RaphaelS1 avatar Oct 19 '22 15:10 RaphaelS1

Do we still want this for the printed book? Not sure if it makes much sense there. But definitely need a quickstart for the online version.

larskotthoff avatar Oct 20 '22 08:10 larskotthoff

The printed book will definitely need a preamble as well as installation instructions. Once that's made we could then take something shorter for quickstart, but tbh this could end up being same as mlr3 readme

RaphaelS1 avatar Oct 20 '22 09:10 RaphaelS1