prql icon indicating copy to clipboard operation
prql copied to clipboard

docs: integrate book and playground into main website

Open mklopets opened this issue 2 years ago • 6 comments

Closes #632

Two notes:

  • new ugly URLs – this keeps the book & playground's full-screen versions at /book and /playground, and creates new routes (see GIF) that the main menu now links to. Suggestions welcome!
  • the styles of the overall website, the book & the playground are fairly different – not ideal, but I think this change still moves the site in the right direction (we could open a followup issue to theme the playground similarly to the book & code samples)

2022-12-03 18 28 57

mklopets avatar Dec 03 '22 16:12 mklopets

Thanks a lot @mklopets !

I'm +0.8, on some standard deviation scale (is that what we're using? I've seen @aljazerzen say +2 !). The thing I really like about it being integrated is the lack of any friction to trying the lang — reducing even very small frictions keeps people in the funnel...

I also think this would look even nicer if we made the formatting consistent in the playground, but that's something we might need to outsource

FWIW, interestingly, the one I originally linked from https://github.com/prql/prql/issues/632, https://pomsky-lang.org/ doesn't have their playground integrated any longer

(one could imagine that opening page example being a live playground, but we wouldn't want to wait to download the playground to show that...)

max-sixty avatar Dec 03 '22 21:12 max-sixty

I remember being annoyed with this when starting out – the header nav made sense, but the links in the left sidebar of the playground were something I only noticed this week (and I've been using the playground a lot.).

I often found myself going to the playground to try something, realising I didn't know the syntax, and looking for the book. Or, going to the book, and then wanting to test it out in the playground. Having the unified nav makes this way more natural.

So, I'm a +1.5(?)

if we made the formatting consistent in the playground

Do you essentially mean just the colour scheme?

mklopets avatar Dec 03 '22 22:12 mklopets

Yes good points.

I think we can merge given those votes, we'd need some big negatives to not do this...

Re the formatting — yes, the color scheme, and the fonts. Makes sense to have different margins though.

max-sixty avatar Dec 03 '22 22:12 max-sixty

Voting is from python world. It has started as -1, -0, +0, +1, but is sometimes extended to -2, +2.

aljazerzen avatar Dec 03 '22 22:12 aljazerzen

I'll take a quick stab at unifying the styles a bit more before merging.

mklopets avatar Dec 04 '22 00:12 mklopets

I'll take a quick stab at unifying the styles a bit more before merging.

OK great! TBC, I didn't mean we had to bundle them. Great if you're up for it but fine to merge any change, however marginal :)

max-sixty avatar Dec 04 '22 00:12 max-sixty

@mklopets shall we hit the button?

max-sixty avatar Jan 13 '23 19:01 max-sixty

Apologies for the delay; I updated the branch to make it work with the latest changes to the website.

But, I didn't get around to doing anything to unify the colours between the different parts of the site. @max-sixty I'll leave this with you – please merge it if you'd like, or close it if you don't care for it. My +/- points are listed above

mklopets avatar Jan 25 '23 13:01 mklopets

Great, thank you @mklopets !

max-sixty avatar Jan 26 '23 00:01 max-sixty