Skip to content

Add Java SDK docs, Context7 widget, and API documentation updates#155

Merged
MarketDataApp merged 17 commits into
mainfrom
staging
Jun 29, 2026
Merged

Add Java SDK docs, Context7 widget, and API documentation updates#155
MarketDataApp merged 17 commits into
mainfrom
staging

Conversation

@MarketDataApp

Copy link
Copy Markdown
Owner

Summary

Promotes the current staging branch to production. Highlights:

  • Java SDK documentation — full sdk/java/ section (authentication, client, settings, installation, plus stocks/options/funds/markets/utilities endpoints), Java logo, and sdk/index.mdx listing
  • Context7 chat widget — enabled on JavaScript SDK pages
  • API docs — expanded coverage across authentication, options, stocks, funds, markets/status, utilities, and troubleshooting (real-time data, service outages, concurrent requests, bad-request, logging, URL-too-long limit)
  • Export toolingscripts/export-sdk-docs.js renders DocCardList as a markdown link list; lib/mdx-to-md.js updates with tests
  • CI — serialize deploys per branch to prevent concurrent R2 sync races; Slack notify metadata via headers; integration test timeout bumped to 180s

Test plan

  • Verify Java SDK pages render at www-staging.marketdata.app/docs/sdk/java/
  • Confirm Context7 widget loads on JavaScript SDK pages
  • Post-deploy integration/e2e tests pass

MarketDataApp and others added 17 commits May 29, 2026 15:40
Live-sitemap fetch tests in worker/handler.integration.test.js
intermittently time out at 30s against staging/production deploys.
Doubling the per-test timeout to 60s should absorb the slow tail
without masking real regressions.
Add Case 5 to bad-request troubleshooting covering the 4094-byte request
line limit, and link to it from the prices and bulkcandles endpoints with
a 500-symbol batching recommendation. Also remove stale indices endpoints
from the status response example.
60s was still tripping on Cloudflare's slow tail — the canonical
Link header test in worker/handler.integration.test.js timed out
on /docs/account/data-policies/professional-status/ in the latest
post-deploy run. With ~400 sequential fetches per run against
staging + production edges, the long tail still wins occasionally.
Tripling to 180s should absorb it without masking real regressions.
The workflow name "Docs: Post-Deploy Integration & E2E Tests"
contains spaces, a colon, and an ampersand. Expanded into the
query string, ${GITHUB_WORKFLOW} produced a URL with raw spaces
that curl rejected with CURLE_URL_MALFORMAT (exit 3), so failure
notifications never reached Slack from any of the three docs
workflows.

Match the marketdata-amember pattern: keep only static, URL-safe
values in the query string, and pass workflow/repo/branch/sha/run_id
as X-* HTTP headers where whitespace is legal.
…races

Two pushes in quick succession ran concurrent 'aws s3 sync --delete' jobs
into the same R2 prefix; each build's --delete removed the other's freshly
uploaded chunks, producing a deploy with mismatched HTML and JS assets
(404'd runtime chunks, dead client-side JS). Add a per-branch concurrency
group with cancel-in-progress so only one deploy runs at a time.
Section index pages (stocks, options, markets, funds, utilities) use
<DocCardList items={useCurrentSidebarCategory().items} /> to list their
endpoint pages. The exporter dropped the component entirely, so the READMEs
shipped to the SDK repos lost their endpoint links and rendered as a bare
intro paragraph.

Render it as a markdown bullet list of links to the section's child pages,
ordered by sidebar_position. The export script computes each index's children
(title + relative href) and passes them to cleanMdx; callers that supply no
items (the worker) keep the prior drop-the-component behavior.
Maps /sdk/js to the repo-backed Context7 library /marketdataapp/sdk-js.
@MarketDataApp
MarketDataApp merged commit c95ac31 into main Jun 29, 2026
10 of 11 checks passed
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.

2 participants