Skip to content

docs: fix stale references across README and architecture docs - #472

Merged
collinsezedike merged 1 commit into
mainfrom
docs/overhaul-stale-references
Aug 4, 2026
Merged

docs: fix stale references across README and architecture docs#472
collinsezedike merged 1 commit into
mainfrom
docs/overhaul-stale-references

Conversation

@collinsezedike

Copy link
Copy Markdown
Collaborator

Summary

  • README: moves per-position yield-earned display from "in progress" to "working today" — it's fully shipped (positions.ts computes it via get_principal, PositionSummary.tsx already renders it)
  • README: fixes @stellar/stellar-sdk version claim (v12 → v14, matches every package.json in the monorepo, all pinned to ^14.6.1)
  • README + 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 yet
  • README roadmap: Q3 2026 wording updated to reflect that basic yield tracking is shipped, only the history chart remains; Q4 2026 wording updated to reflect that rebalance() itself exists, the gap is exposing it
  • docs/contracts.md: the vault section predated the adapter-pattern refactor entirely — it described deposit(caller, amount, route_to), a get_active_protocol() entry point, and no set_adapter/get_adapter/get_admin, none of which match the current contract. Replaced with an accurate summary and a pointer to apps/docs/architecture/vault-contract.md, which is already correct and detailed, so the two don't keep drifting apart independently
  • docs/contracts.md: fixes the router's documented rebalance signature and return type to match the actual code — no route_to: Protocol parameter exists, and it returns Result<i128, RouterError>, not a raw i128 with a panic on slippage
  • apps/docs/architecture/api.md: fixes the same stale claim from the other direction — there's no Protocol enum passed into a deposit call; vaultId resolves directly to a specific deployed vault contract address via known-pools.ts
  • apps/docs/architecture/signing-flow.md: removes a reference to a "routing protocol" argument that no longer exists
  • apps/docs/architecture/monorepo.md: fixes a file-tree comment calling the router "reserved for v2" when it's implemented and tested
  • docs/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 time

Every 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 typecheck pass locally
  • pnpm exec prettier --check clean on all changed files
  • Docs-only change, no runtime behavior touched

@vercel

vercel Bot commented Aug 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
meridian Ready Ready Preview Aug 4, 2026 4:07am

@collinsezedike
collinsezedike merged commit 9b499ef into main Aug 4, 2026
9 checks passed
@collinsezedike
collinsezedike deleted the docs/overhaul-stale-references branch August 4, 2026 04:09
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