docs: get-started guide + docs embed package#23
Conversation
Add docs/get-started.md, an author-facing getting-started guide written terminal-first (hard-wrapped at <=76 columns, no HTML/images/wide tables) so it renders cleanly in an 80x24 SSH TUI: quickstart with shellcade-kit new/check/play, publishing to the public games catalog, and linking GitHub over SSH. Add the docs package that embeds it as docs.GetStarted for the arcade's "Add your own game" screen, plus a minor changeset. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| Grab the one author tool, `shellcade-kit` (scaffold, verify, play), from | ||
| this repo's Releases: | ||
|
|
||
| https://github.com/shellcade/kit/releases |
There was a problem hiding this comment.
Should offer brew for macOS, and this as an alternative inside an expand.
There was a problem hiding this comment.
Done in dc9c7d5. The Quickstart now leads with the macOS brew command:
brew install shellcade/tap/shellcade-kit
(the documented cask from the GoReleaser homebrew_casks config — its
post-install hook strips quarantine, and brew downloads skip it anyway).
The manual Releases download — and the xattr quarantine note, which is
only relevant to hand-downloaded binaries — now lives inside a <details>
expand titled "Manual download (Linux / Windows / no brew)". The <details>
/</details> tag lines sit alone between blank lines, so GitHub collapses
the block while glamour (the shellcade TUI renderer) drops the raw HTML tag
lines and still renders the inner markdown inline — terminal users in the
"Add your own game" screen lose nothing. All lines stay <=76 cols.
Lead the Quickstart with `brew install shellcade/tap/shellcade-kit` for macOS (the documented cask), and move the manual Releases download into a <details> expand for Linux/Windows/no-brew. The HTML tag lines sit alone between blank lines, so GitHub collapses the block while glamour (the shellcade TUI renderer) drops the raw tags and still renders the inner markdown inline — terminal users lose nothing. The quarantine note moves with the manual path (the brew cask strips quarantine itself). Lines stay <=76 cols. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
What
Adds an author-facing getting-started guide and a small Go package that
embeds it so the shellcade arcade can render it directly in its "Add your
own game" screen (a glamour-rendered Markdown pane inside the 80x24 SSH
TUI).
docs/get-started.md— the guide. Sections: what a shellcade game is,Quickstart (
shellcade-kit new/go mod tidy/go run ./check/
play), Publish your game (PR to the public games catalog; a mergedPR cuts a release; an operator reviews and takes it live), Link your
GitHub (connect over SSH and use the User menu so games attribute to
you), and Where to go next (GUIDE.md / ABI.md).
docs/docs.go—package docs, embeds the guide asdocs.GetStarted.docspackage export.Content rules
is 74) with no HTML, images, badges, or wide tables, so it renders
cleanly in the pager. 70 lines total.
and the public repos github.com/shellcade/kit and
github.com/shellcade/games — no internal references.
Notes
The Quickstart points authors to this repo's Releases for the
shellcade-kitbinary, matching the install method documented inREADME.md and GUIDE.md (there is no
go installpath published for thetool).
go build ./...andgo test ./...pass; the new file is gofmt-clean.🤖 Generated with Claude Code