Skip to content

docs: Erlang quick start + phases/seasons/matchmaker-strategies + glossary#41

Open
Taure wants to merge 4 commits intomainfrom
docs/devex-polish
Open

docs: Erlang quick start + phases/seasons/matchmaker-strategies + glossary#41
Taure wants to merge 4 commits intomainfrom
docs/devex-polish

Conversation

@Taure
Copy link
Copy Markdown
Contributor

@Taure Taure commented Apr 23, 2026

Summary

Five new pages closing Erlang-path credibility and hidden-feature gaps from the 2026-04-23 DevEx audit:

  • /docs/glossary — asobi vs asobi_lua vs asobi.dev Cloud, plus concept vocabulary. Linked from the docs overview card grid and sidebar.
  • /docs/erlang/getting-started — dedicated 20-minute Erlang quick start. rebar3 new app → asobi_match → sys.config → rebar3 shell → wscat → code:load_file/1 hot reload. Links to the companion examples/erlang-match/ project.
  • /docs/phases — phase engine + four timer primitives (countdown, conditional, cycle, scheduled), Erlang + Lua side-by-side with the on_phase_started / on_phase_ended callbacks.
  • /docs/seasons — lifecycle, query API, honest note that the Lua bridge isn't wired yet.
  • /docs/erlang/matchmaker-strategiesasobi_matchmaker_strategy behaviour contract + worked party-aware example.

Also:

  • Quickstart Option A (Lua) deploy step changed from asobi-cli deploy to a docker-compose volume mount (CLI depends on managed cloud which isn't public yet).
  • Docs overview card grid: Erlang quick start replaces the Erlang API card; glossary card added.

Closes audit items #1, #2, #5, #6, #7, #8.

Test plan

  • All five new pages render on the dev server
  • Sidebar shows new entries under Get started, Gameplay systems, Erlang reference
  • rebar3 compile && rebar3 fmt --check && rebar3 xref && rebar3 dialyzer && rebar3 ct all green
  • CI green

Taure added 4 commits April 23, 2026 23:25
New page + sidebar entry under Get started, linked from the docs
overview card grid. Clears up "asobi vs asobi_lua vs asobi.dev Cloud"
confusion at first contact.

Also swaps the quickstart Lua deploy step from 'asobi-cli deploy' to
a docker-compose volume mount, since the CLI depends on the managed
cloud which isn't public yet.
New /docs/erlang/getting-started, sidebar entry under Erlang reference,
card on docs overview. Walks from rebar3 new app through asobi_match
behaviour, sys.config wiring, rebar3 shell boot, wscat verification,
and code:load_file/1 hot reload in one page.

Closes the Erlang-path credibility gap surfaced by the 2026-04-23
DevEx audit: before, Erlang devs were sent to the bilingual tic-tac-toe
tutorial with no standalone entry point.
Three pages surfacing previously-invisible gameplay systems:

- /docs/phases — phase engine + the four timer primitives
  (countdown, conditional, cycle, scheduled), Erlang + Lua examples.
- /docs/seasons — season lifecycle, config, queries. Notes that
  game.season from Lua isn't wired yet.
- /docs/erlang/matchmaker-strategies — the asobi_matchmaker_strategy
  behaviour contract plus a worked party-aware example.

Sidebar additions:
- Gameplay systems: Phases & timers, Seasons
- Erlang reference: Matchmaker strategies

Closes audit items #2 (phases/timers/seasons under-documented),
#7 (custom matchmaker strategies undocumented), and #8 (seasons
mentioned in README without a reference page).
- Adds a callout linking to examples/erlang-match/ as the no-scaffold
  path (git clone && rebar3 shell).
- Updates register curl password from hunter2 (7 chars, fails 422) to
  hunter-2026 so the snippet actually works against nova_auth's
  minimum-length validation.
@github-actions
Copy link
Copy Markdown

🟡 ELP Lint — 3 warnings

4 diagnostics found. See job logs for details.

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