Sitelet https://github.com/alloy-rs/examples/pull/251
Skip to content

feat(examples): add validated example catalog - #251

Merged
mattsse merged 3 commits into
mainfrom
mattsse/examples-catalog
Jul 16, 2026
Merged

mattsse merged 3 commits into
mainfrom
mattsse/examples-catalog

Conversation

@mattsse

@mattsse mattsse commented Jul 16, 2026

Copy link
Copy Markdown
Member

Summary

  • add a generated, machine-readable index for all 111 real Cargo example targets
  • attach source paths, summaries, exact commands, networks, environment variables, binaries, services, and hardware requirements
  • validate catalog and README coverage in CI
  • add agent and contributor guidance for finding and maintaining examples
  • convert shared contract helpers from an accidental example executable into the package library
  • make runtime artifact lookup independent of the caller working directory

Why

Cargo metadata exposed a helper module as a runnable example, while the human README omitted a real receipt-decoding target. Agents and users also had no structured way to distinguish offline examples from examples requiring networks, processes, credentials, or hardware.

Impact

Every real example now has a stable discovery record and a CI-enforced README entry. Consumers can select compatible examples without trial-and-error, and shared helpers no longer pollute the executable target list.

This PR is stacked on #250 so cataloged runtime requirements match the explicit endpoint configuration introduced there.

@mattsse
mattsse requested a review from onbjerg July 16, 2026 11:01
@mattsse
mattsse force-pushed the mattsse/examples-rpc-configuration branch from 706ead8 to 2e018c2 Compare July 16, 2026 14:35
@mattsse
mattsse changed the base branch from mattsse/examples-rpc-configuration to main July 16, 2026 14:39
@mattsse
mattsse force-pushed the mattsse/examples-catalog branch from 29fc63c to c1651fc Compare July 16, 2026 14:39
@mattsse
mattsse merged commit d1251c6 into main Jul 16, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this to Done in Alloy Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant