Skip to content

docs(examples): apply EXAMPLE_STANDARD documentation to board and puzzle examples #223

Description

@salazarsebas

Background

Board and puzzle examples include README.md files, but none satisfy the eight required sections in EXAMPLE_STANDARD.md §4. Several retain monolithic lib.rs layouts without components.rs or systems.rs separation.

Objective

Bring board and puzzle examples to the documented quality standard for structure, documentation, and test coverage.

In scope

Examples: chess, checkers, connect_four, reversi, sudoku, minesweeper, memory_match, tic_tac_toe

Per example:

  1. Rewrite README.md per EXAMPLE_STANDARD.md §4.
  2. Adopt module separation where complexity warrants it.
  3. Ensure cougr-core = "1.1.0".
  4. Classify as transitional unless all checklist items in EXAMPLE_STANDARD.md are satisfied.
  5. Include the completed quality checklist in the pull request description.

Out of scope

  • Game rule engine rewrites.
  • ZK proof integration changes in chess.

Definition of done

  • All eight examples pass cargo test and stellar contract build.
  • Pull request includes a completed quality checklist for each example.

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationexampleNew game example contract

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions