docs: replace boilerplate README with a full StepFi-API guide - #136
Merged
Merged
Conversation
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
1 participant
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.
🔗 Related Issue
N/A — documentation task.
🔖 Title
docs: replace boilerplate README with a full StepFi-API guide
📝 Description
The README was leftover Supabase CLI boilerplate (wrong title, wrong install/usage, a CI badge pointing at a fork) with only two StepFi sections spliced in. This replaces it with a complete, accurate guide to the actual service and adds a committed system-architecture diagram showing where StepFi-API sits in the protocol.
🔄 Changes Made
README.md: What the service does, module map (16 feature modules), tech stack, quick start + real env vars (from.env.example), scripts, API/Swagger surface, security & observability, CI/CD, roadmap, related repos, license.docs/architecture.svg— the StepFi system diagram with the API box highlighted as "this repo".StepFi-app/StepFi-API; added<!-- LEADERBOARD_START/END -->markers soleaderboard.ymlcan populate the contributors section (it previously had no markers to write into).🗒️ Additional Notes
Documentation only — no runtime code changed. Env-var names were read from the source (
process.env/ config) and.env.example; only placeholder names are documented, no secrets. Links point at existing repo files (ROADMAP.md,SECURITY.md,CONTRIBUTING.md,render.yaml) and the live Swagger docs.