Skip to content

Conversation

@embano1
Copy link
Member

@embano1 embano1 commented Dec 19, 2025

Issue #, if available: n/a

Description of changes:

PR Summary: Enhance Root README for Better Developer Onboarding

Status Badges Added

  • Build – GitHub Actions workflow status
  • NPM Version – Current SDK version on npm
  • OpenSSF Scorecard – Security scorecard (existing)
  • License – Apache 2.0 license badge
  • Node.js – Minimum version requirement (≥22)
  • TypeScript – TypeScript 5.x support

New Sections

  1. Hero Section – Compelling one-liner explaining the value proposition
  2. ✨ Key Features – 7 bullet points highlighting core capabilities
  3. 📦 Packages Table – Lists all 3 NPM packages with descriptions and individual npm version badges
  4. 🚀 Quick Start – Installation + complete code example demonstrating:
    • Root context logger (context.logger.info)
    • Step-scoped logger (stepCtx.logger.debug)
    • Steps and wait operations
  5. 📚 Documentation – Links to AWS docs, SDK README, API reference, concepts, and examples
  6. 🧪 Testing – Testing SDK usage showing:
    • skipTime: true for fast-forwarding through waits
    • Assertions for execution status, result, invocations count, and operations count
    • Operation inspection by name
  7. 💬 Feedback & Support – Direct links to issue templates:
    • Bug reports
    • Feature requests
    • Documentation issues
    • GitHub Discussions

Benefits

  • Developers can understand the SDK's purpose within seconds
  • Project health visible at a glance via badges
  • Copy-paste ready code example to get started quickly
  • Clear paths to documentation and support channels

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Signed-off-by: Michael Gasch <[email protected]>
Signed-off-by: Michael Gasch <[email protected]>
@embano1
Copy link
Member Author

embano1 commented Dec 21, 2025

@anthonyting done

@anthonyting anthonyting merged commit 9086fd7 into aws:main Dec 22, 2025
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants