docs(oracle): correct experiments.mdx paths + add oracle-deployed.mdx#56
Merged
Conversation
Closes the doc-drift half of gh #576 (issues #1, #2, #4): experiments.mdx endpoints table fixes: - /api/v1/oracle/simulate -> /api/v1/oracle/simulate/run (plus new rows for /simulate/generate, /simulate/presets, /simulate/history) - /api/v1/oracle/exec-config -> /api/v1/oracle/exec-config/defaults (the bare path was always a server SPA fallback, not a JSON endpoint) - /api/v1/oracle/leaderboard -> reworded to "curated persona roster" with a pointer to the new deployed page; the previous description ("best-performing strategies across recent experiments") was incorrect after Oracle's persona restructure. - /api/v1/oracle/results -> annotated that experiment_id is optional, and the unfiltered path returns the cross-experiment view. - New row for /api/v1/oracle/deployed/strategies linking to the new oracle-deployed page. New oracle-deployed.mdx documents the live execution-state surface (strategies, state, events, SSE stream) that replaces the old leaderboard-as-ranking shape. Includes curl + SDK examples for each endpoint and a "why leaderboard returns personas" section so customers don't fall into the same trap. mint.json: insert "api-reference/oracle-deployed" after experiments (Oracle endpoints group together). Sibling PRs closing the rest of #576: - MangroveOracle PR #237 (BQ ORDER BY fix — issue #3) - MangroveAI PR #580 (proxy allowlist for /oracle/deployed/*) - MangroveAI-SDK PR (incoming — 9 new typed methods + live example) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Member
Author
Ship instructions — step 5 of 6Status: CI green (test 3.10/3.11/3.12 + CodeQL all pass), MERGEABLE, blocked only on review approval. Safe to merge any time independently — the SDK v1.4.0 references in the doc will become accurate once SDK PR #14 ships, but a customer reading the doc today against SDK v1.3.0 won't be misled because the new method calls are wrapped in code blocks that reference the upcoming version explicitly. After clicking merge: # KB uses the workflow per memory feedback_kb_release_must_use_workflow — never manual tag.
gh workflow run release.yml --repo MangroveTechnologies/MangroveKnowledgeBase --ref main -f version=v1.0.6The release workflow:
Verify the new page is live: curl -sS https://docs.mangrovedeveloper.ai/api-reference/oracle-deployed | head -3
# Expect MDX content, not 404.Next: mangrove-agent #82 (pin bump after SDK v1.4.0 hits PyPI). |
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
Closes the doc-drift half of MangroveAI gh #576 (issues #1, #2, #4). The KB was claiming Oracle endpoints that don't exist at the documented paths, leaving customers staring at SPA
index.htmlresponses (issues #1 and #2) or expecting a strategy-ranking response that's actually a persona roster (#4).Changes
docs/api-reference/experiments.mdx— endpoint table corrections:POST /api/v1/oracle/simulate→POST /api/v1/oracle/simulate/run(plus new rows for/simulate/generate,/simulate/presets,/simulate/history)GET /api/v1/oracle/exec-config→GET /api/v1/oracle/exec-config/defaultsGET /api/v1/oracle/leaderboarddescription reworded: "Curated persona roster — wrappers for the deployed strategies on the public dashboard. See Deployed strategies for live execution state."GET /api/v1/oracle/resultsannotated to clarifyexperiment_idis optional (cross-experiment view when omitted).GET /api/v1/oracle/deployed/strategieslinking to the new page.docs/api-reference/oracle-deployed.mdx(NEW) — ~60-line page covering:GET /oracle/deployed/strategies(list with live state)GET /oracle/deployed/{id}/state(per-strategy execution snapshot)GET /oracle/deployed/{id}/events(recent trade history)GET /oracle/deployed/stream(SSE)docs/mint.json— insert\"api-reference/oracle-deployed\"after experiments (Oracle endpoints group together).Test plan
python -m json.tool docs/mint.json→ valid JSONSibling PRs closing the rest of #576
🤖 Generated with Claude Code