docs(readme): reflect live deploy, on-chain perp, and shipped pipeline - #125
Merged
Merged
Conversation
The README still described VolX as an M1-in-progress, read-only research project with no on-chain components. That no longer matches reality: the full pipeline, public API, on-chain Sepolia perp, and CI/CD deploy are all live. - Project status: M1 done, M2 in progress (multi-venue + perp + deploy shipped); roadmap checkmarks updated to match. - API section: 'planned' -> live, real base URL (volx-api.ancilar.com), example payload matches the actual response shape. - Security: drop the false 'no on-chain components / no wallet code' claim; document the testnet contract + keeper-key surface and the Cloudflare Tunnel exposure model. - Tech stack deploy row + 'exchange-neutral' bullet: match the shipped self-hosted + Netlify + Docker Hub setup and live multi-venue blend. - Fix the stale #api-planned anchor in the header nav and contents.
The WS example carried the old planned shape. Match the actual ClientTick emitted by api/internal/stream/hub.go: no 'data' wrapper, 'channel' (not 'index_id'), 'type':'tick', and 'ts' as Unix epoch milliseconds. Subscribe channels are lower-case index ids.
The Phase 2 milestone (OKX + Bybit connectors, per-venue strip + median blend, outlier drop, confidence score, per-service Dockerfiles) is fully shipped and the milestone is closed, as is the on-chain perp milestone. The previous status table conflated M2 with later, unscoped hardening work (API keys, status page, backups) and so read 'in progress'. - Status table: M2 + on-chain perp + deploy/CI-CD marked Complete; M3 in progress (methodology + dashboard live, aggregator listings pending). - Roadmap: M2 checked off; unbuilt hardening moved to a 'Future' line. - Moved API keys / rate-limit tiers / status page / backups out of M2 and into clearly-future work across the API, security, and perf sections.
…tor listings Public launch is shipped: methodology page, public dashboard, and the live backend + frontend deploy are all up. External aggregator/directory submissions and product analytics were never project goals, so they are removed from the roadmap rather than tracked as pending. - Status table + roadmap: M3 -> Complete. - Remove 'aggregator submissions' from What's next. - Retag stale 'Oracle Cloud (M3)' repo-layout comments to the actual self-hosted + Cloudflare deploy.
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.
What
Refresh
README.mdso it matches the project's current live state. The README still read like an M1-in-progress, read-only research project with no on-chain components — which directly contradicts the on-chain perp section further down and the live deployment.Changes
(planned)-> live; real base URLvolx-api.ancilar.com; example request + JSON payload now match the actual response shape (index,source_strip_hash,next_update_eta_seconds). WS URL updated. Fixed the stale#api-plannedanchor in the header nav + contents.Verification
grepconfirms no staleapi.volx.dev/api-planned/ "no on-chain components" / "Oracle Cloud" strings remain.