docs: fix stale references across README and architecture docs - #472
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
positions.tscomputes it viaget_principal,PositionSummary.tsxalready renders it)@stellar/stellar-sdkversion claim (v12 → v14, matches everypackage.jsonin the monorepo, all pinned to^14.6.1)docs/contracts.md: corrects the router description. It's not "reserved for a future v2 feature" —rebalance()is implemented, tested, and works today; it's just not exposed through the API or UI yetrebalance()itself exists, the gap is exposing itdocs/contracts.md: the vault section predated the adapter-pattern refactor entirely — it describeddeposit(caller, amount, route_to), aget_active_protocol()entry point, and noset_adapter/get_adapter/get_admin, none of which match the current contract. Replaced with an accurate summary and a pointer toapps/docs/architecture/vault-contract.md, which is already correct and detailed, so the two don't keep drifting apart independentlydocs/contracts.md: fixes the router's documentedrebalancesignature and return type to match the actual code — noroute_to: Protocolparameter exists, and it returnsResult<i128, RouterError>, not a rawi128with a panic on slippageapps/docs/architecture/api.md: fixes the same stale claim from the other direction — there's noProtocolenum passed into a deposit call;vaultIdresolves directly to a specific deployed vault contract address viaknown-pools.tsapps/docs/architecture/signing-flow.md: removes a reference to a "routing protocol" argument that no longer existsapps/docs/architecture/monorepo.md: fixes a file-tree comment calling the router "reserved for v2" when it's implemented and testeddocs/signing-flow.md: removes references to issues [API] Build unsigned Soroban deposit and withdraw transaction XDR #14 and [Frontend] Implement Freighter wallet adapter #8 as open implementation targets — both have been closed for a long timeEvery claim above was checked directly against the current contract/handler code before being changed, not just against what the docs said.
Test plan
pnpm lint && pnpm typecheckpass locallypnpm exec prettier --checkclean on all changed files