#221 reconcile EXAMPLE_STANDARD.md and catalog with cougr-core 1.1.0 …#229
Conversation
…-core 1.1.0 FIXED
|
@solidsole Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
salazarsebas
left a comment
There was a problem hiding this comment.
Review — request changes (documentation accuracy)
Good structural work. This PR correctly reconciles EXAMPLE_STANDARD.md with the 1.1.0 canonical set and adds the monorepo path-dependency exception (§1.1), which is the right architectural call.
Required fix
The document references builder types that do not exist in the public API:
| Documented (incorrect) | Actual API in cougr_core::circuits |
|---|---|
HiddenHandBuilder |
hidden_cards |
FogExplorerBuilder |
fog_of_war |
FairDiceBuilder |
fair_dice |
SealedBidBuilder |
sealed_bid |
Please update §7, §8, and the API–Example Cross Reference table to use the real function names. Incorrect names will mislead external integrators reading this as authoritative documentation.
Optional improvement
Add a one-line note in §8 that circuits::* functions return GameCircuitSpec and are Experimental, matching CHANGELOG.md.
Verdict
Merge once API names match the codebase. No code CI required for this docs-only change.
|
Done! I have updated the builder names to their correct public API function names ( I also implemented the optional improvement by adding the note clarifying that Ready for another look and merge! Thanks for the review. |
|
PLEASE REVIEW... AND PING ME BACK |
|
@salazarsebas please review... |
|
Hi @salazarsebas , Thanks so much for reviewing and approving the fix! I noticed that the points for this contribution haven't been awarded on Drips yet. Usually, this happens if the underlying issue needs to be officially closed or if the distribution needs to be triggered from your side on the platform. Could you please double-check your Drips dashboard when you get a moment to see if there's an action needed to release the rewards? Thanks again for your time and for maintaining this project! |
…md-and-catalog-with-cougr-core-1.1.0-FIX
Findings and Fix Summary
Problem Identified
Three documentation files were inconsistent about which examples are canonical, how to handle path dependencies, and what APIs should be documented:
EXAMPLE_STANDARD.md §7 listed only 3 canonical examples (snake, battleship, guild_arena) — the pre-1.1.0 set — while the 1.1.0 release added 7 more (spawn_and_move, tic_tac_toe, session_arena, hidden_hand, fog_explorer, dice_duel, blind_auction).
EXAMPLE_STANDARD.md §1 mandated published crate dependencies but 7 canonical examples used path = "../../" because their APIs aren't yet on crates.io. This contradiction was undocumented.
EXAMPLE_STANDARD.md §8 lacked guidance for new 1.1.0 APIs: SorobanGame, impl_soroban_game!, session::SessionManager, circuits::*, and test::GameHarness.
examples/README.md was missing 16 examples from its catalog (including 5 canonical ones) and had no recommended reading order.
CHANGELOG.md didn't mention the canonical set expansion, creating an inconsistency with the other docs.
CLOSE #221