Skip to content

docs: get-started guide + docs embed package#23

Merged
BCook98 merged 2 commits into
mainfrom
add-get-started-doc
Jun 6, 2026
Merged

docs: get-started guide + docs embed package#23
BCook98 merged 2 commits into
mainfrom
add-get-started-doc

Conversation

@BCook98

@BCook98 BCook98 commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

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 merged
    PR 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.gopackage docs, embeds the guide as docs.GetStarted.
  • a minor changeset for the new docs package export.

Content rules

  • Terminal-first: prose is hard-wrapped at <=76 columns (current max
    is 74) with no HTML, images, badges, or wide tables, so it renders
    cleanly in the pager. 70 lines total.
  • Public author content only: sourced from this repo's README/GUIDE
    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-kit binary, matching the install method documented in
README.md and GUIDE.md (there is no go install path published for the
tool).

go build ./... and go test ./... pass; the new file is gofmt-clean.

🤖 Generated with Claude Code

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>
Comment thread docs/get-started.md
Grab the one author tool, `shellcade-kit` (scaffold, verify, play), from
this repo's Releases:

https://github.com/shellcade/kit/releases

@BCook98 BCook98 Jun 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should offer brew for macOS, and this as an alternative inside an expand.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@BCook98
BCook98 marked this pull request as ready for review June 6, 2026 09:02
@BCook98
BCook98 merged commit 80b4960 into main Jun 6, 2026
5 checks passed
@BCook98
BCook98 deleted the add-get-started-doc branch June 6, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant