docs: fix README — correct project name, broken code blocks, placeholder text, and API accuracy - #11
Merged
Conversation
…s, accurate API docs
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.
What changed
bash# comment(language tag fused to code) replaced with properly fenced blocksenvblocks fixed —envCONTRACT_ADDRESS=...style replaced with proper fencedenvblocks# SentientFiheading was absent; README started mid-sentencehttps://github.com/your-username/stellar-portfolio-rebalancer.git(placeholder + wrong name)[Hackathon Name]replaced with descriptive wording/api/v1/*is the canonical namespace (v1Router is not currently mounted;/api/*is what works)ADMIN_PUBLIC_KEYSdocumented — was missing from configuration examples, causing admin routes to 503 on fresh installsHMAC webhook signaturesandReflector integrationas tracked itemsWhy
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
Verify the code blocks render correctly on GitHub's README preview.