Skip to content

Refresh the hackathon-era claims in the README and full_product_breakdown #345

Description

@Otaiki1

Context

README.md (24KB) and full_product_breakdown.md (40KB) were written for a hackathon submission and
carry claims that are now stale or unverified:

  • YOUR_VIDEO_URL is still a placeholder, in a line that appears twice (lines 51 and 52).
  • The demo-GIF comment block at lines 44–50 describes a GIF that does not exist.
  • The "48.0M / 100M instructions" figure is hand-maintained prose that no test checks.
  • The on-chain evidence table cites specific testnet transactions that a testnet reset will erase.
  • The contract described in the breakdown predates cancel_circle, get_circle_count, has_claimed, RoundFull, Overflow, and CircleCancelled.

The repo has moved on; its front page has not.

Where to build it

  • README.md — lines 44–52 (the GIF block and duplicated link line), the evidence table, and the "why this was hard" section.
  • full_product_breakdown.md — the contract API and error-code sections.
  • docs/hackathon/ — the genuinely hackathon-specific material can stay as an archive; say so.

What to do

  • Remove the duplicated link line and either record the demo video or drop the placeholder.
  • Either produce the demo GIF or delete the comment block describing where it would go.
  • Replace the inline instruction-count figure with a link to contracts/BENCHMARKS.md.
  • Add a dated note to the evidence table explaining that testnet artifacts do not survive a reset, and link the reset runbook.
  • Update the breakdown's contract API section to the current eight error codes and full entrypoint list.
  • Mark docs/hackathon/* explicitly as a point-in-time archive that is not maintained.

Acceptance criteria

  • No placeholder text remains on the README's front page.
  • Every factual claim on the README is either checked by a test or dated.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationtech-debtDead code, drift, cleanup

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions