Skip to content

docs: fix README — correct project name, broken code blocks, placeholder text, and API accuracy - #11

Merged
Uchechukwu-Ekezie merged 1 commit into
grantFoxin:mainfrom
OpenSourceCOntr:main
Jun 16, 2026
Merged

docs: fix README — correct project name, broken code blocks, placeholder text, and API accuracy#11
Uchechukwu-Ekezie merged 1 commit into
grantFoxin:mainfrom
OpenSourceCOntr:main

Conversation

@Uchechukwu-Ekezie

@Uchechukwu-Ekezie Uchechukwu-Ekezie commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Project name corrected throughout — was "Stellar Portfolio Rebalancer" everywhere; now correctly reads "SentientFi"
  • Broken code blocks fixed — 12+ instances of bash# comment (language tag fused to code) replaced with properly fenced blocks
  • env blocks fixedenvCONTRACT_ADDRESS=... style replaced with proper fenced env blocks
  • Missing project title added# SentientFi heading was absent; README started mid-sentence
  • Clone URL corrected — was https://github.com/your-username/stellar-portfolio-rebalancer.git (placeholder + wrong name)
  • Placeholder text removed[Hackathon Name] replaced with descriptive wording
  • API reference corrected — removed claim that /api/v1/* is the canonical namespace (v1Router is not currently mounted; /api/* is what works)
  • Price feeds clarified — noted CoinGecko is current, Reflector backend integration is planned (Phase 2)
  • Architecture table added — tech stack presented in a readable table
  • ADMIN_PUBLIC_KEYS documented — was missing from configuration examples, causing admin routes to 503 on fresh installs
  • Docker deployment section updated — structure and commands kept accurate
  • Roadmap updated — Phase 2 now lists HMAC webhook signatures and Reflector integration as tracked items

Why

The README was displaying incorrect/placeholder content that doesn't match the actual project, making it hard for new contributors to set up the project correctly.

How to test

git clone https://github.com/grantFoxin/SentientFi.git
cd SentientFi
# Follow Quick Start steps in the updated README

Verify the code blocks render correctly on GitHub's README preview.

@Uchechukwu-Ekezie
Uchechukwu-Ekezie merged commit 4e10a07 into grantFoxin:main Jun 16, 2026
1 check failed
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