Skip to content

feat: docs index, Soroban cheat sheet, README diagram, and referral code generator - #1490

Merged
joelpeace48-cell merged 4 commits into
FinesseStudioLab:mainfrom
oomokaro1:feat/stellar-wave-1366-1369
Oct 20, 2026
Merged

joelpeace48-cell merged 4 commits into
FinesseStudioLab:mainfrom
oomokaro1:feat/stellar-wave-1366-1369

Conversation

@oomokaro1

Copy link
Copy Markdown
Contributor

Closes #1366, Closes #1367, Closes #1368, Closes #1369

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring (no functional or behavioral changes)
  • Performance improvement
  • Documentation update
  • Build / CI configuration change
  • Dependency update
  • Other:

Summary

Four small, self-contained deliverables for the Stellar Wave issues:

  1. feat(infra): Docker Compose dev environment auto-reload file watcher #1366 — Document Docker Compose dev auto-reload (bind-mount + node --watch / Vite HMR) and add DOCUMENTATION_INDEX.md as the central docs map.
  2. feat(documentation): Interactive Soroban smart contract parameter cheat sheet #1367 — Add docs/SOROBAN_CHEAT_SHEET.md mapping Soroban host functions (storage, TTL, auth, events, crypto) to their arguments, plus both contracts' storage keys and TTL constants.
  3. feat(documentation): Add Architecture Diagram in Mermaid format to main README #1368 — Embed a Mermaid architecture diagram in the main README Architecture section.
  4. feat(growth): Automated referral code generator for partner Twitter influencers #1369 — Add a referral code generator (trivela.network/ref/<code>) for partner Twitter influencers: backend service + POST /api/v1/referral-codes / GET /api/v1/referral-codes/:code routes, frontend helper, and 10 unit tests.

Motivation / Context

Closes #1366, Closes #1367, Closes #1368, Closes #1369

These issues share the goal of improving developer onboarding, architecture transparency, and growth instrumentation for the Trivela platform on Stellar Soroban. Docs changes are additive; the referral generator is a new isolated route that does not affect existing API contracts.

Verification

  • node --test src/services/referralCodeService.test.js — 10/10 pass
  • New files pass eslint and prettier --check
  • No changes to existing behavior (docs + new route only)

Add DOCKER_DEV_HOT_RELOAD.md covering the bind-mount + node --watch /
Vite HMR setup in compose.yaml, verification steps, and troubleshooting.
Introduce DOCUMENTATION_INDEX.md as the central docs map.

Closes FinesseStudioLab#1366
Publish a quick-reference mapping Soroban host functions (storage, TTL,
auth, events, crypto) to their arguments, plus both Trivela contracts'
instance storage keys and TTL constants. Linked from the docs index.

Closes FinesseStudioLab#1367
Embed a Mermaid flowchart of frontend, backend, Soroban RPC, contracts,
and the event indexer directly in the README Architecture section.

Closes FinesseStudioLab#1368
Add a referral code service and API that slugifies influencer names or
Twitter handles into trivela.network/ref/<code> links. Expose
POST /api/v1/referral-codes and GET /api/v1/referral-codes/:code, with a
matching frontend helper. Unit tests cover slugify edge cases and link
generation.

Closes FinesseStudioLab#1369
@oomokaro1
oomokaro1 force-pushed the feat/stellar-wave-1366-1369 branch from 3333969 to 66f81a9 Compare October 20, 2026 13:10
@drips-wave

drips-wave Bot commented Oct 20, 2026

Copy link
Copy Markdown

@oomokaro1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@joelpeace48-cell
joelpeace48-cell merged commit dc1aaf9 into FinesseStudioLab:main Oct 20, 2026
10 of 28 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

2 participants