docs: add getting started guide

[coodos]

Description of change

add getting started guide

Issue Number

Type of change

• Docs (changes to the documentation)

How the change has been tested

Change checklist

• I have ensured that the CI Checks pass locally
• I have removed any unnecessary logic
• My code is well documented
• I have signed my commits
• My code follows the pattern of the application
• I have self reviewed my code

Summary by CodeRabbit

• Documentation
  • Added comprehensive Getting Started guide for Platform Development authentication, including end-to-end authentication flow, JWT token generation, middleware patterns, and implementation examples
  • Added Webhook Controller guide documenting webhook integration flows, packet structures, mapping lookups, and implementation patterns

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds two comprehensive documentation guides for Platform Development in the metastate ecosystem: a Getting Started guide covering authentication flow with w3ds://auth, JWT token generation, and middleware patterns; and a Webhook Controller guide detailing webhook packet processing including mapping lookup and transformation logic.

Changes

Cohort / File(s)

Summary

Platform Development Guides docs/getting-started.md, docs/webhook-controller.md

Introduces comprehensive Getting Started guide documenting end-to-end authentication flow (client-offer generation, user sign-in, signature verification, JWT token generation with 7-day expiry, middleware patterns) with implementation examples for eCurrency-api endpoints and utilities. Introduces Webhook Controller guide documenting webhook packet processing flow (structure, mapping lookup via schemaId, transformation, existence check, save/update logic) with error handling and conditional hooks.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Multiple code examples and implementation patterns require verification for technical accuracy and consistency
• Authentication flow documentation involves security-sensitive details (JWT generation, signature verification) that need careful review
• Webhook controller documentation spans packet structure, mapping logic, and database interactions requiring cross-reference verification
• Consider verifying that code examples align with actual API endpoints and schema structures

Poem

🐰 Bouncing through new docs with cheer,
Auth flows crystalline and clear,
Webhooks map from there to here,
Sign and verify, have no fear!
The warren's wisdom now appears,
Development joy for pioneers! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/getting-started-guide

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46f3dd6 and e47458f.

📒 Files selected for processing (2)

• docs/getting-started.md (1 hunks)
• docs/webhook-controller.md (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}