andymeneely / squib

A Ruby DSL for prototyping card games.
http://squib.rocks
MIT License
917 stars 67 forks source link

The Squib Way documentation skips over the `squib new` command #387

Open joem opened 4 months ago

joem commented 4 months ago

I was following along with The Squib Way documentation, specifically Pt 1: Zero To Game, and I got rather confused when I missed the squib new command. Granted, I was going quickly through it at the time, but when I realized I must have missed something and I slowed down and went back to look for what I missed, I still had issues finding it. It's not mentioned in the paragraphs of text at all, it's only shown in one code example, and there it's mixed in with several other commands. I think it deserves a bit more focus than that, and some paragraph text about what it does. I imagine this will help beginners and folks like me who are refreshing their knowledge.

(Sorry if this report is categorized wrong, but there wasn't a "documentation issue" option.)