docs: apply reviewed wiki editorial corrections
docs: improve Web SDK documentation style
docs: refine Web SDK requests and behavior guidance
docs: apply Genetec style guide fixes to web-sdk pages
docs: standardize See also descriptions across remaining families
Adopt the canonical-summary pattern across the GWP, Macro SDK, Media
Gateway, and Web SDK pages whose See also sections were touched in
earlier commits this session. Same change previously applied to
Plugin SDK (af4ddd7), Platform SDK (a32f681), and Media SDK (28361b5).
Canonical descriptions used for cross-referenced targets:
- gwp-developer-guide: Embedding the Genetec Web Player in browser-based applications.
- gwp-api-reference: Genetec Web Player API reference (TypeScript definitions and methods).
- gwp-sample-application: Single-player GWP sample with playback, PTZ, and dewarping controls.
- gwp-multiplexing-sample: Multi-camera GWP grid sharing one WebSocket connection.
- media-gateway-developer-guide: RTSP and HTTP video streaming through the Media Gateway role.
- macro-sdk-developer-guide: Writing macro C# code with the Macro SDK.
- web-sdk-overview: Web SDK conceptual model, architecture, and session lifecycle.
- web-sdk-getting-started: Authentication, your first API call, and Web SDK role setup.
- web-sdk-reference: Well-known GUIDs, card format identifiers, and enumerations.
- web-sdk-entity-operations: The /entity endpoint and shared q= query syntax.
- web-sdk-referencing-entities: Entity discovery, search, and parameter formats.
- web-sdk-reports: The /report endpoint and report query filters.
- web-sdk-actions: The /action endpoint and operational commands.
- web-sdk-events-and-alarms: Event subscriptions, real-time streaming, and alarm operations.
- web-sdk-custom-fields: Custom entity properties.
- web-sdk-performance-guide: Optimizing Web SDK performance.
- web-sdk-troubleshooting: Diagnosing common Web SDK issues.
- web-sdk-under-the-hood: How q= requests are interpreted and route limitations.
- Postman Collection: Ready-to-use example requests for Web SDK endpoints.
docs: style audit pass on web-sdk-overview
Resolves findings from a wiki-style-reviewer audit on the page.
Major:
- ALERT-01: Session explained section had 2 IMPORTANT alerts in one
scope. Promoted 4 inline labels to H4 sub-headers (Session identity,
Shared sessions, Separate sessions, Session lifecycle). Each H4 now
holds at most one alert. Side-effect: also resolved the inline
pseudo-callout labels (FMT-08 borderline).
- ALERT-03: The line-49 IMPORTANT contained 3 unrelated paragraphs
(architecture rule, no-CORS warning, self-signed TLS warning). Kept
the architecture rule as the alert; lifted CORS and TLS warnings
into regular prose paragraphs immediately after.
Minor:
- WORD-05: Standardized "Web SDK Role" to "Web SDK role" (4 occurrences:
Mermaid diagram label, 2 numbered list items, 1 alert sentence).
- FMT-04: Removed bold-plus-backticks combination on Keep-alive request
table cell. Removed bold from the entire Session lifecycle table's
first column for consistency.
- PH-01: Lowercase placeholders user1 and appID1 to USER1 and APPID1
in both code blocks.
- VOICE-01: Rewrote "Session timeout is reset by activity from either
application" to active form "Activity from either application resets
the session timeout."
- VOICE-07: Rewrote "Understanding how the Web SDK works will help you
build robust integrations" to drop the nominalization: "Knowing how
the Web SDK works helps you build robust integrations."
docs: correct Web SDK reference description in overview See also
The Web SDK reference page contains well-known GUIDs, constants, and
enumerations, not an endpoint catalog. Update the See also description
to match the page's actual content.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: split Web SDK overview from getting started, simplify Home and Sidebar
Move the conceptual half of web-sdk-getting-started (intro, what the
Web SDK is, architecture, sessions) into a new web-sdk-overview page so
every SDK follows the same overview-then-getting-started pattern. Trim
the original page to procedural and reference content only, fix
numbered-list indentation in the Step-by-step authentication block, and
add a one-line pointer back to the overview.
Simplify Home.md to the Start-here decision tree plus the sidebar
pointer; drop the redundant ## Start here section in _Sidebar.md (every
overview was already linked under its SDK section). Normalize the macro
SDK overview to ## See also so all six overview pages use the same
heading.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>