Add code examples to docs

[mattpocock]

I recently ported a cli to Stricli and noticed some documentation was lacking. Consider these suggestions from someone with fresh eyes, and feel free to close this issue without implementing them.

Code Examples

The docs are sorely lacking code examples. Nowhere in the first 5 pages on the menu of the site is there a single code example showing what Stricli code actually looks like.

The tutorial is the best example of this. It asks the user to npx @stricli/create-app@latest my-app. This is useful for folks who want to generate a new CLI, but suboptimal for people who want to migrate to stricli, as I did.

The first place I'd put a code example is on the overview page. Let me see what Stricli code looks like. Give me a 'Stricli in 100 lines' overview right there.

'Structure of a Stricli App'

Another thing that is sorely missing is a simple guide on Stricli's most important functions: run, buildRouteMap, buildCommand. This can serve as a kind of index page for the other pages of the docs which go deeper.

I would call this the tutorial, and rename the current tutorial to 'Quickstart'. I expect a tutorial to teach me about the thing, and quickstart to show me how to get it up and running.

[molisani]

Thanks very much for the great feedback! I think every part of this issue is actionable, and I'll try to get on it ASAP (example code, migration guide, intro to the API, etc.)

There was originally a plan to extend the live playground from the Argument Parsing pages to show a full application on the landing page (and have a separate playground page) but we didn't have enough time to fully implement that for the initial release.

[molisani]

I will be finally circling back to this issue soon. All of the currently in-flight PRs related to documentation are groundwork for the action items here. Once they're in I'm going to reorganize a lot of documents so we have a "structure" section (parsing/routing/context) and a "features" section (config/autocomplete/out-of-scope). This new structure section will also have an index page that serves as a general migration guide, linking to the necessary subpages.