Consistent Network Docs

Ensure all networking-related documentation uses consistent terminology, clean markdown formatting, and readable structure. Apply this standard to any page covering protocols/features like Pub/Sub, WebSockets, SSE, MQTT, etc.

copy reviewer prompt

Prompt

Reviewer Prompt
Deploy Agent

Ensure all networking-related documentation uses consistent terminology, clean markdown formatting, and readable structure.

Apply this standard to any page covering protocols/features like Pub/Sub, WebSockets, SSE, MQTT, etc.

  • Use consistent terms and capitalization (e.g., “real-time”, “WebSockets”).
  • Structure content with clear headings and short sections (concept → how it works → key commands/approaches).
  • Keep markdown formatting hygienic (e.g., always end files with a trailing newline).
  • When adding educational material, include at least one trusted external resource link (official docs or a reputable reference).

Example (pattern to follow in Markdown):

# Topic Title

## What is topic?
Short, plain-language definition of the networking concept.

## How it works
1–3 sentences describing the flow/behavior.

## Key commands / options
- `COMMAND_1`
- `COMMAND_2`

Learn more from the following resources:
- [@official@Topic documentation](https://example.com)

Source discussions