add market support and limitations documentation#84
Conversation
- Create MARKET_SUPPORT.md with comprehensive guide to supported exchanges - Document TradingView and Finnhub API limitations - Add troubleshooting section for 'symbol only available on TradingView' error - Update README.md table of contents with new Market Support section - Addresses issue Open-Dev-Society#83 by clearly explaining why NSE and other markets may have limitations
|
@akoweicollinxx is attempting to deploy a commit to the ravixalgorithm's projects Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughA new ChangesMarket Support Documentation
Possibly Related PRs
Poem
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@MARKET_SUPPORT.md`:
- Line 24: The Greece example uses the inconsistent ticker suffix `ETE.ATH`
while the code maps ATHEX symbols using the `.AT` suffix; update the
documentation example to `ETE.AT` so it matches the code's mapping for ATHEX
(references: example symbol `ETE.ATH`, corrected symbol `ETE.AT`, mapping key
`ATHEX`).
- Line 29: Update the Portugal Euronext ticker example in MARKET_SUPPORT.md from
`BCP.LI` to `BCP.LS` so it matches the Finnhub mapping used in the code (see the
`'.LS': 'EURONEXT'` entry in lib/utils.ts); edit the example text to use
`BCP.LS` and ensure any nearby examples or notes referencing Euronext Lisbon use
the `.LS` suffix consistently.
- Line 19: Update MARKET_SUPPORT.md to match the actual TradingView prefix used
in code/tests: change the Spain entry from "BMAD" to "BME" (or add a short
parenthetical explaining that BMAD is the local exchange name while TradingView
uses the "BME" prefix). This ensures consistency with the .MC mapping in
lib/utils.ts (which maps `.MC` -> `BME`) and the assertion in
__tests__/utils.test.ts (which expects `SAN.MC` => `BME:SAN`).
- Line 43: MARKET_SUPPORT.md documents Philippines tickers using the `.PH`
suffix but lib/utils.ts's FINNHUB_TO_TRADINGVIEW_EXCHANGE is missing a `.PH` =>
`PSE` entry, causing formatSymbolForTradingView to fail converting `*.PH`
symbols; add a mapping key '.PH' with value 'PSE' in the
FINNHUB_TO_TRADINGVIEW_EXCHANGE object (and update any related lookup logic in
formatSymbolForTradingView if it assumes different suffix casing) so that
symbols like `JFC.PH` correctly convert to `PSE:JFC`.
- Line 25: The FINNHUB_TO_TRADINGVIEW_EXCHANGE mapping in lib/utils.ts is
missing the Ireland ISE suffix `.IR`, so Finnhub tickers like `RY.IR` are not
being translated to the TradingView exchange prefix; update the
FINNHUB_TO_TRADINGVIEW_EXCHANGE constant to include the `.IR` key mapped to the
appropriate TradingView exchange code for ISE (so translation logic in functions
that reference FINNHUB_TO_TRADINGVIEW_EXCHANGE will correctly convert `.IR`
tickers).
- Line 148: Replace the incorrect Pine Script link URL in the markdown entry for
"[TradingView Widget Documentation]" so the link points to the official widget
docs; locate the line containing the link text "[TradingView Widget
Documentation]" and change its URL from
"https://www.tradingview.com/pine-script-docs/" to
"https://www.tradingview.com/widget-docs".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 15b5b7f2-da4d-488e-ac83-63ea5ce3e442
📒 Files selected for processing (2)
MARKET_SUPPORT.mdREADME.md
| ## 📚 References | ||
|
|
||
| - [Finnhub API Documentation](https://finnhub.io/docs/api) | ||
| - [TradingView Widget Documentation](https://www.tradingview.com/pine-script-docs/) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check if the TradingView widget documentation URL is accessible
curl -s -o /dev/null -w "%{http_code}" "https://www.tradingview.com/widget/"
echo ""
curl -s -o /dev/null -w "%{http_code}" "https://www.tradingview.com/pine-script-docs/"Repository: Open-Dev-Society/OpenStock
Length of output: 77
🌐 Web query:
TradingView embedded widget documentation official URL
💡 Result:
The official documentation for TradingView embedded widgets can be found at https://www.tradingview.com/widget-docs [1]. This central hub provides comprehensive guidance on integrating financial widgets, including tutorials, configuration details, and explanations of the available widget formats [1][2][3]. TradingView offers two primary integration methods: iframe-based widgets and modern Web Components, with specific documentation for both provided on the site [4][3].
Citations:
- 1: https://www.tradingview.com/widget-docs
- 2: https://www.tradingview.com/widget-docs/tutorials/iframe/build-page/widget-integration/
- 3: https://en.tradingview.com/widget-docs/tutorials/web-components/configuring/
- 4: https://www.tradingview.com/widget-docs/widget-formats/
Update TradingView documentation reference to correct widget docs URL.
The link text references "TradingView Widget Documentation" but points to Pine Script documentation. Update to the official TradingView widget documentation URL: https://www.tradingview.com/widget-docs.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@MARKET_SUPPORT.md` at line 148, Replace the incorrect Pine Script link URL in
the markdown entry for "[TradingView Widget Documentation]" so the link points
to the official widget docs; locate the line containing the link text
"[TradingView Widget Documentation]" and change its URL from
"https://www.tradingview.com/pine-script-docs/" to
"https://www.tradingview.com/widget-docs".
|
Thanks @akoweicollinxx for contributing to Open Dev Society ❤️ |
2 participants
Summary by CodeRabbit