Skip to content

Conversation

Ansonhkg
Copy link
Collaborator

WHAT

Added network status and health monitoring documentation to the SDK docs

@Copilot Copilot AI review requested due to automatic review settings October 14, 2025 22:41
Copy link
Contributor

@Copilot Copilot AI left a 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.

Comment on lines +59 to +61
const client = createLitStatusClient({
url: process.env.API_URL,
apiKey: process.env.READ_KEY,
Copy link

Copilot AI Oct 14, 2025

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.

Suggested change
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,
Copy link

Copilot AI Oct 14, 2025

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,
Copy link

Copilot AI Oct 14, 2025

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>
@Ansonhkg Ansonhkg merged commit 012afdc into naga Oct 15, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v8 | Naga

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant