Skip to content

Commit e038dc0

Browse files
committed
Fix documentation violations and broken README link
- Fix broken INTEGRATION_GUIDE.md link in README - Remove TBD placeholders - Remove non-existent features (customLoops, subscribeToPosition) - Remove banned phrase "Comprehensive" - Fix import path in code examples - Remove placeholder support links
1 parent a898484 commit e038dc0

File tree

4 files changed

+5223
-44
lines changed

4 files changed

+5223
-44
lines changed

DEPLOY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ git remote add origin git@github.com:Genmin/forecast-leverage-sdk.git
5454
git add .
5555
git commit -m "Initial release v1.0.0
5656
57-
- Complete leverage SDK
57+
- Leverage SDK
5858
- Target-based UX
59-
- Comprehensive validation
59+
- Input validation
6060
- 19 test suite
61-
- Full documentation
61+
- Documentation
6262
- CI/CD configured"
6363

6464
git push -u origin main

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const position = await sdk.openTargetPosition({
3737

3838
## Documentation
3939

40-
See [INTEGRATION_GUIDE.md](./INTEGRATION_GUIDE.md) for complete integration instructions.
40+
See [INTEGRATION_GUIDE.md](./docs/INTEGRATION_GUIDE.md) for integration instructions.
4141

4242
## Testing
4343

docs/INTEGRATION_GUIDE.md

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Users specify price targets and timeframes. The SDK calculates the required leve
99
## Quick Start
1010

1111
```typescript
12-
import { ForecastLeverageSDK } from "./ForecastLeverageSDK";
12+
import { ForecastLeverageSDK } from '@forecast-protocol/sdk';
1313

1414
const sdk = new ForecastLeverageSDK(
1515
"https://polygon-rpc.com",
@@ -281,38 +281,6 @@ Polymarket API has rate limits:
281281
- Use EIP-2612 permits where possible
282282
- Consider gas price for profitability
283283

284-
## Advanced Features
285-
286-
### Custom Loop Strategy
287-
288-
Override default loop calculation:
289-
290-
```typescript
291-
const position = await sdk.openTargetPosition({
292-
...params,
293-
customLoops: 3, // Force exactly 3 loops
294-
});
295-
```
296-
297-
### Partial Close
298-
299-
Close some legs, keep others:
300-
301-
```typescript
302-
await sdk.closePosition(position.legIds.slice(0, 2)); // Close first 2 legs
303-
```
304-
305-
### Real-Time Updates
306-
307-
Subscribe to WebSocket for position updates:
308-
309-
```typescript
310-
const ws = sdk.subscribeToPosition(position.legIds);
311-
ws.on('priceUpdate', (price) => {
312-
// Update UI with current PnL
313-
});
314-
```
315-
316284
## Troubleshooting
317285

318286
"Order failed to fill"
@@ -336,14 +304,8 @@ ws.on('priceUpdate', (price) => {
336304

337305
Polygon Mainnet:
338306
```
339-
Protocol: TBD (deploy to mainnet)
340307
USDC: 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174
341308
CTF: 0x4D97DCd97eC945f40cF65F87097ACe5EA0476045
342-
Polymarket Exchange: 0x4bFb41d5B3570DeFd03C39a9A4D8dE6Bd8B8982E
343309
```
344310

345-
## Support
346-
347-
- Documentation: https://docs.forecast.protocol
348-
- Discord: TBD
349-
- GitHub: TBD
311+
Protocol address provided at deployment.

0 commit comments

Comments
 (0)