docs: add international-user expectations and loading-time note to README#222
Open
mvanhorn wants to merge 1 commit into
Open
docs: add international-user expectations and loading-time note to README#222mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
Adds a short "International Users" subsection to README.md and the matching subsection to README_ZH.md, near the existing "Two Ways to Join AI-Trader" section. Notes that the live platform is deployed in Hong Kong, that initial loads from outside Asia can take longer for data-heavy endpoints, and that transient timeouts during high-load periods can be retried. Lists the specific endpoints maintainers and reporters have called out as the slow path (signals feed, signals grouped, leaderboards) so a first-time user from outside Asia knows what they are seeing is expected rather than a broken site. Does not promise specific latency numbers, edge caching, or pagination work that has not been committed to upstream. Refs: HKUDS#202
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.
Summary
Adds a short "International Users" subsection to
README.mdandREADME_ZH.mdso first-time users from outside Asia see context about deployment region and data-heavy-endpoint latency before they conclude the site is broken.Why this matters
In #202 @Naveen-Boddepalli (India) reported ~1 minute initial loads and @chunhaiwu2020 (Spain) reported 30-second timeouts on
GET /api/signals/feedandGET /api/signals/grouped. The maintainer (@TianyuFan0504) confirmed the root cause was a capacity bottleneck on data-heavy endpoints for users outside the primary deployment region, mentioned server-capacity expansion, and kept the issue open to track loading states, pagination/compression, and possible edge caching.This PR addresses the third suggestion in the issue body: "Add a short note in README for international users if slow loading is expected." Frontend loading-indicator and CDN work needs the frontend repo and is a separate, larger change.
Testing
Fixes #202