search

Raku / user-experience

Identifying issues in and improving the Raku user experience
Artistic License 2.0
25 stars 5 forks source link

examples.perl6.org in need of some improvement? #24

Open timo opened 6 years ago

timo commented 6 years ago

The current method of organisation for the perl6 examples page is not terribly helpful if you don't already know what these things are. What is a newbie to expect from a category named "99 problems", even if the description says it's "based on lisp 99 problems"? What's the language shootout benchmark game to someone close to getting bored and closing all perl6 related tabs?

Instead of the current categorisation I'd maybe suggest having tags based on broad topics?

The spread of examples between tiny and big is very uneven. There's an example for "lazy evaluation" that's just the usual Fibonacci implementation. Another random example i looked at was a "weighted roll" which probably could just have been Bag.pick.

The section "Perl 6 Tutorial Examples" should either be drastically expanded or perhaps thrown out, it's far too small to be useful to someone who'd actually need a tutorial.

Perhaps we should go through all examples and remove things that don't reach some level of quality (that we'd of course have to define up front).

~The examples don't have syntax highlighting, which just looks kind of bad.~ Syntax highlighting was easy to fix!

There should be integration of a "run code from your browser" service like glot.io, tio.run, ideone.com, … that - if possible - directly includes the source of the example in there.

Also, I think we ought to take far more than just the 12 examples we have from rosettacode, and probably check if the 12 we do have are up to date compared to rosettacode itself (i hear ingy is going to update his rosettacode-data repository soon, which could make this easier to accomplish).

Feel free to toss out any or all of my suggestions; this is just a braindump I typed out after failing to fall asleep for an hour and a half.

softmoth commented 6 years ago

I'd lean towards getting rid of the whole examples section. Maybe tag modules in the ecosystem that are good for studying instead, since those will be maintained. For simpler examples, those should be in docs/Language itself, IMO.

AlexDaniel commented 6 years ago

@softmoth I sort of agree, and I also mentioned that on IRC.

rafaelschipiura commented 6 years ago

@softmoth @AlexDaniel The next upgrade @zoffixznet is working on will send people to glot.io, so it will be an entry point for people to start playing with the language.

zoffixznet commented 6 years ago

The next upgrade @zoffixznet is working on will send people to glot.io

Don't recall on working on anything of that sort. Do you mean executable examples? They'd be executed in-page, like on perl6.party so no one would be sent to glot.io. Also, that work is currently on hold as mentioned in https://github.com/perl6/perl6.org/issues/114