-
Notifications
You must be signed in to change notification settings - Fork 87
feat(docs): add Network Status resource and update introduction with … #953
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docs): add Network Status resource and update introduction with … #953
Conversation
…monitoring details
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds network status and health monitoring documentation to the Lit Protocol SDK docs, providing developers with visibility into real-time network performance and uptime metrics.
Key Changes:
- Creates comprehensive network status documentation with monitoring dashboards for development and test networks
- Integrates experimental Lit Status SDK with programmatic access examples
- Updates the SDK introduction to include the new network monitoring section
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
File | Description |
---|---|
docs/sdk/resources/network-status.mdx | New documentation page covering network status dashboards, monitored operations, and SDK usage examples |
docs/sdk/introduction.mdx | Adds network status section to the main SDK introduction |
docs/docs.json | Updates navigation structure to include the new network status resource |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
const client = createLitStatusClient({ | ||
url: process.env.API_URL, | ||
apiKey: process.env.READ_KEY, |
Copilot
AI
Oct 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Environment variables should be validated before use. Consider adding checks to ensure API_URL and READ_KEY are defined to prevent runtime errors.
const client = createLitStatusClient({ | |
url: process.env.API_URL, | |
apiKey: process.env.READ_KEY, | |
const API_URL = process.env.API_URL; | |
const READ_KEY = process.env.READ_KEY; | |
if (!API_URL || !READ_KEY) { | |
throw new Error('Missing required environment variables: API_URL and/or READ_KEY'); | |
} | |
const client = createLitStatusClient({ | |
url: API_URL, | |
apiKey: READ_KEY, |
Copilot uses AI. Check for mistakes.
|
||
// Get recent metrics for a specific function | ||
const executeJsMetrics = await client.getFunctionMetrics( | ||
functions['executeJs'].id, |
Copilot
AI
Oct 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The function ID 'functions['executeJs'].id' is hardcoded and repeated. Consider extracting it to a variable or demonstrating how to iterate over multiple functions to reduce duplication.
Copilot uses AI. Check for mistakes.
|
||
// Get time-series data for charting | ||
const timeSeries = await client.getFunctionMetricsTimeSeries( | ||
functions['executeJs'].id, |
Copilot
AI
Oct 14, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The function ID 'functions['executeJs'].id' is hardcoded and repeated. Consider extracting it to a variable or demonstrating how to iterate over multiple functions to reduce duplication.
Copilot uses AI. Check for mistakes.
…page-links-to-the-doc Signed-off-by: Anson <ansonox@gmail.com>
WHAT
Added network status and health monitoring documentation to the SDK docs