Background
examples/EXAMPLE_STANDARD.md and examples/README.md present conflicting guidance on which examples constitute canonical references. Section 7 of the standard still lists snake, battleship, and guild_arena as the sole canonical examples, while the catalog already documents a different set aligned with the 1.1.0 release (spawn_and_move, session_arena, ZK circuit examples).
Section 1 mandates published crate dependencies, but seven canonical examples currently use path dependencies — a constraint that should be documented explicitly for monorepo contributors.
Objective
Eliminate documentation inconsistencies and establish a single authoritative reference for example classification, API guidance, and recommended reading order.
In scope
-
Rewrite EXAMPLE_STANDARD.md §7 to reflect the 1.1.0 canonical set:
- Starter:
spawn_and_move
- Rich components:
tic_tac_toe
- Session UX:
session_arena
- ZK circuits:
hidden_hand, fog_explorer, dice_duel, blind_auction
- Arcade (
GameApp): snake
- Hidden information (
privacy::stable): battleship
- Authentication and recovery:
guild_arena
-
Add a subsection under §1 documenting when path dependencies are permitted during monorepo development and when they must be replaced with published versions.
-
Extend §8 with guidance for SorobanGame, impl_soroban_game!, session::SessionManager, circuits::*, and test::GameHarness.
-
Synchronize examples/README.md: correct the catalog, add missing entries, and define a recommended reading order.
Out of scope
Definition of done
- No contradictions exist between
EXAMPLE_STANDARD.md, examples/README.md, and the CHANGELOG.md 1.1.0 section.
- Every example in the catalog is classified as canonical or transitional.
- A recommended reading order is documented for new contributors.
Background
examples/EXAMPLE_STANDARD.mdandexamples/README.mdpresent conflicting guidance on which examples constitute canonical references. Section 7 of the standard still listssnake,battleship, andguild_arenaas the sole canonical examples, while the catalog already documents a different set aligned with the 1.1.0 release (spawn_and_move,session_arena, ZK circuit examples).Section 1 mandates published crate dependencies, but seven canonical examples currently use path dependencies — a constraint that should be documented explicitly for monorepo contributors.
Objective
Eliminate documentation inconsistencies and establish a single authoritative reference for example classification, API guidance, and recommended reading order.
In scope
Rewrite
EXAMPLE_STANDARD.md§7 to reflect the 1.1.0 canonical set:spawn_and_movetic_tac_toesession_arenahidden_hand,fog_explorer,dice_duel,blind_auctionGameApp):snakeprivacy::stable):battleshipguild_arenaAdd a subsection under §1 documenting when path dependencies are permitted during monorepo development and when they must be replaced with published versions.
Extend §8 with guidance for
SorobanGame,impl_soroban_game!,session::SessionManager,circuits::*, andtest::GameHarness.Synchronize
examples/README.md: correct the catalog, add missing entries, and define a recommended reading order.Out of scope
Definition of done
EXAMPLE_STANDARD.md,examples/README.md, and theCHANGELOG.md1.1.0 section.