docs: apply reviewed wiki editorial corrections
docs: correct GetTile and SendUserTaskToMonitor behavior
docs: private user tasks are not directory entities
docs: improve SDK documentation accuracy and clarity
docs: normalize See also descriptions and remove cross-SDK leakage
- Capitalize first letter of See also descriptions per wiki-style-reviewer
LIST-01/LIST-06/LINK-09 across 29 pages
- Apply canonical descriptions for shared cross-references (0
inconsistencies across 109 cross-references)
- Remove Platform -> Web/Workspace/Plugin See also links (audience
mismatch: Platform SDK reader does not reach for Web/Workspace/Plugin
SDK from a C# integration context)
- Remove 2 inline Platform -> Web body cross-references
- Add IsNetworkSettingsCombinationValid result examples and PTZ
zoom-factor explanation in web-sdk-video.md
docs(platform-sdk): standardize See also descriptions across the family
Adopt the canonical-summary pattern: each target page has one
canonical description used everywhere it appears. Same change
previously applied to Plugin SDK in commit af4ddd7. This commit
extends it to the 17 Platform SDK pages whose See also sections
were touched in earlier commits this session.
Canonical descriptions used:
- platform-sdk-overview: SDK assemblies and the Engine class.
- platform-sdk-getting-started: Engine setup, authentication, and signing in to Security Center.
- platform-sdk-compatibility: Backward-compatibility rules between client and server SDK versions.
- platform-sdk-certificates: SDK certificate fundamentals shared across all SDK families.
- platform-sdk-referencing-assemblies: Referencing SDK assemblies and runtime resolution.
- platform-sdk-entities: Entity model and IPartitionSupport.
- platform-sdk-entity-cache: How the Engine caches entity data locally.
- platform-sdk-events: Subscribing to system events from the Platform SDK.
- platform-sdk-actions: Receiving actions directed at entities.
- platform-sdk-transactions: Batching multiple entity operations into one request.
- platform-sdk-partitions: Partition membership, access control, and partition exceptions.
- platform-sdk-privileges: Privilege types, states, and per-user privilege computation.
- platform-sdk-custom-events: Defining and raising custom events.
- platform-sdk-report-manager: Running queries against the Directory and processing results.
- platform-sdk-report-manager-query-reference: The full catalog of query types, filters, and result schemas.
- platform-sdk-download-all-related-data-and-strict-results: How configuration queries control which entities load and which appear in the result.
- platform-sdk-logging: SDK logging configuration and severity levels.
- workspace-sdk-content-builders: Content class hierarchy and properties for Security Desk tile content.
- plugin-sdk-deployment: Plugin packaging, registration, and deployment.
- plugin-sdk-custom-entities: Defining custom entity types from a plugin.
docs(platform-sdk): per-page style audit on Security Desk interaction
Add a See also section linking to Connecting to Security Center, content
builders in the Workspace SDK, and the Engine entity cache. The two
inline See references mid-page (Application entities and content
builders) are kept in place as inline cross-references.
docs: clean implementation-framing from wiki pages
docs: systemic style cleanup across Platform SDK pages
Batch 1 of 5 in the uncommitted working-tree cleanup. Ten Platform SDK
pages get the same mechanical style fixes that were already applied to
most of the wiki in earlier session commits:
- Flatten **Label:** bold pseudo-alerts to plain prose or promote to
proper headings (FMT-08)
- Sentence-case Title Case headings (HDR-05)
- Strip meaning-carrying emoji (FMT-07)
- Add missing language annotations to code fences (CODE-01)
- Fold a handful of filler "Benefits" sections into prose (AGENTS.md)
- Normalize whitespace
No content rewrites, code-example changes, or link edits.
Files: platform-sdk-certificates, platform-sdk-custom-events,
platform-sdk-entity-cache, platform-sdk-getting-started,
platform-sdk-logging, platform-sdk-partitions, platform-sdk-privileges,
platform-sdk-referencing-assemblies, platform-sdk-security-desk,
platform-sdk-transactions.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: add Security Desk guide, workspace component pages, and Application entity docs
New files:
- platform-sdk-security-desk: Interacting with Security Desk (monitors,
tiles, content XML, user tasks, messages, sounds, privacy)
- workspace-sdk-badge-printers, credential-encoders, credential-readers,
custom-actions, dashboard-widgets, incidents, logon-providers, pages,
pinnable-content-builders, report-pages, shared-components, tasks:
Dedicated component documentation split from workspace-sdk-components
Updated files:
- platform-sdk-getting-started: Add Application entity section with
ApplicationType, engine.Client/ClientGuid, disconnect lifecycle
- workspace-sdk-components: Convert to hub page linking to component pages
- workspace-sdk-content-builders: Add tile numbering and Security Desk link
- workspace-sdk-overview: Update architecture diagram
- workspace-sdk-tiles: Fix CameraContent to VideoContent, add SDK cert note
- workspace-sdk-monitors: Link to shared-components page
- workspace-sdk-events: Clarify extended fields scope, add Title property
- workspace-sdk-map-extensions: Add SDK certificate note
- plugin-sdk-net8: Update PluginInstallation XML format to Version 2
- plugin-sdk-threading: Clarify engine thread vs background thread callbacks
- _Sidebar: Add entries for all new pages
Removed:
- workspace-sdk-tasks-and-pages: Split into workspace-sdk-tasks and
workspace-sdk-pages