Skip to content

docs: overhaul README with system architecture diagram and roadmap - #103

Merged
EmeditWeb merged 1 commit into
mainfrom
docs/readme-overhaul
Sep 28, 2026
Merged

EmeditWeb merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@EmeditWeb

Copy link
Copy Markdown
Member

Summary

Documentation-only overhaul of the repository README so StepFi-Web reads like the rest of the protocol repos. Adds a committed system-architecture diagram (public/architecture.svg) that highlights StepFi-Web's role in the whole system, a scripts reference, a CI/CD section, and a roadmap table. Also adds the MIT LICENSE file the README badge was already pointing at.

This repo is for the React web app only

No product code changed — this is docs + a static SVG asset + the license file.

  • Changes are documentation only (README.md, LICENSE, public/architecture.svg)
  • No Rust, Soroban, or contract code added
  • No React Native or Expo-specific code added
  • No hardcoded hex colors in app code (the SVG asset is a diagram, not UI)
  • No new icons added
  • No API calls added

Type of change

  • Documentation

What changed

  • Embedded public/architecture.svg — the StepFi system diagram with the Web box highlighted as "this repo".
  • Added a Scripts table (dev / build / preview / lint / test / test:coverage / test:a11y).
  • Added a CI/CD section (required ci.yml gate; Netlify + Vercel deploys).
  • Added a Roadmap table reflecting current sponsor / vendor / mentor feature status.
  • Added the MIT LICENSE file (the README badge already referenced ./LICENSE).

Testing

  • Docs-only change; no code paths affected. Existing ci.yml (lint · test · build) remains the gate.

@EmeditWeb
EmeditWeb merged commit 9a703a8 into main Sep 28, 2026
2 checks passed
@EmeditWeb
EmeditWeb deleted the docs/readme-overhaul branch September 28, 2026 15:35
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.

1 participant