docs: overhaul README with system architecture diagram and roadmap - #103
Merged
Merged
Conversation
…ap, and MIT license
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 MITLICENSEfile 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.
README.md,LICENSE,public/architecture.svg)Type of change
What changed
public/architecture.svg— the StepFi system diagram with the Web box highlighted as "this repo".dev/build/preview/lint/test/test:coverage/test:a11y).ci.ymlgate; Netlify + Vercel deploys).LICENSEfile (the README badge already referenced./LICENSE).Testing
ci.yml(lint · test · build) remains the gate.