docs: correct and complete the README - #325
Merged
Merged
Conversation
The quick start pointed at a non-existent deploy/docker-compose.yml and listed brokers the sandbox stack does not run. Sync every claim with the real repo: compose at the root, the actual service set and ports, the current libs/sdk/examples/web layout, a gateway-free architecture diagram, and a Developer experience section covering the SDKs, CLI, examples, and API collection.
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.
Corrects factual drift in
README.md, verified claim-by-claim against the repo.What changed
deploy/docker-compose.ymlpath withdocker compose up -d(compose lives at the repo root), and documented thescripts/fincorehelper (init/status/run-demo) plus the real service ports.fincoreCLI, runnable examples, and the Bruno API collection.Verification
Every claim fact-checked against the filesystem and
docker-compose.yml(code-reviewer gate: PASS). No em/en-dash, no AI-tells.