-
Notifications
You must be signed in to change notification settings - Fork 17
CI-tested examples/ directory (Stellar-first) #22
Copy link
Copy link
Open
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programdocsDocumentationDocumentationdripsFunded via Drips NetworkFunded via Drips NetworkdxDeveloper experienceDeveloper experiencehelp wantedExtra attention is neededExtra attention is neededstellarTouches Stellar / Soroban codeTouches Stellar / Soroban code
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programdocsDocumentationDocumentationdripsFunded via Drips NetworkFunded via Drips NetworkdxDeveloper experienceDeveloper experiencehelp wantedExtra attention is neededExtra attention is neededstellarTouches Stellar / Soroban codeTouches Stellar / Soroban code
Type
Fields
Give feedbackNo fields configured for issues without a type.
Labels:
Stellar Wave,stellar,dx,docs,drips,help-wantedTier: L (1–2 weeks)
Type: dx / docs
Context
Today, a developer who wants to see a complete Wraith integration has to:
getting-started.mdxsnippets,stellar-quickstart.mdxsnippets (if issue docs/01 has landed),That's three different mental contexts. We want a self-contained
examples/directory in the SDK repo with complete, runnable, CI-tested sample apps.Scope
Create
sdk/examples/with subdirectories, starting Stellar-first:examples/stellar-cli-send/node send.mjs <recipient-meta-address> <amount>examples/stellar-cli-scan/node scan.mjs <viewing-key>examples/stellar-react-receive/examples/stellar-spectre-agent/examples/multichain-scan/Each example:
package.jsonwith explicit dep on the local SDK build.README.mdwith prerequisites + run command..env.examplefor any required config.Tests
tests/examples/).Acceptance criteria
examples/README.mdindexing them with one-liners.docs/getting-started.mdx.Why this matters
"Read the docs" is the second-worst onboarding instruction. "Read the code" is the third-worst. "Run this example, then read the code" is the first-best.