docs: apply reviewed wiki editorial corrections
docs: apply Genetec style guide to platform-sdk pages
docs: improve SDK documentation accuracy and clarity
docs: fix verified inaccuracies across SDK wiki pages
Corrects claims that did not match SDK 5.14 source or reflection,
including ownership/removal semantics, disposal and lifecycle
behavior, plugin hosting and assembly resolution, entity cache
filtering, and several style and cross-reference fixes.
docs: update reviewed wiki guidance
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
Revert "docs(platform-sdk): canonical alphabetical ordering for See also sections"
This reverts commit 2229e4b6f10517da2090372404ab089c89586de8.
docs(platform-sdk): canonical alphabetical ordering for See also sections
Reorders See also entries alphabetically by link text on the pages
edited this session. Removes editorial bias in which subsystem appears
first; the order is now produced by the link title rather than by an
implicit framing choice. Also lowercases description text where the
prior pattern accidentally had Title Case openings.
docs(platform-sdk): value-density pass on the 14 video and access-control pages
Following an external content-value review, restructured the pages to
cut sections that read as compressed API reference (work IntelliSense
and XML doc comments already do) and lead with the operational and
workflow content that the wiki is uniquely positioned to provide.
Hubs become decision maps. platform-sdk-video.md and
platform-sdk-access-control.md no longer have an H2 per spoke that
introduces a concept and points at the spoke; they now have a short
"Where to go next" route table and keep only the orientation prose
(layered model, "archives go through the report manager", archive
transfer taxonomy, RecordingProblem as health signal, what-if checks
without the hardware).
Spokes become task-oriented. platform-sdk-cameras.md has a "Common
tasks" route block at the top, organizes around configure recording,
trigger manual recording, select streams, manage bookmarks, protect
video, and observe health, and drops property catalog bullets that
restated signatures (recording config, the long VideoStream setter
list, RecordingFrameInterval and StreamingType enum lists, the
adjacent video topics link farm).
platform-sdk-archiver-role.md now answers operational questions
("Which cameras is this archiver responsible for?", "Which server is
running it now?", "How do I detect recording failure before querying
archives?"). The certificate overload list and recording config
member list have been cut.
platform-sdk-cardholders-and-credentials.md, platform-sdk-doors-
and-access-points.md, platform-sdk-access-rules-and-schedules.md,
and platform-sdk-access-control-units.md have similar trim treatment:
"Common use cases" blocks removed, repeated property catalogs replaced
with prose that emphasizes non-obvious behavior, the access control
peripherals enum table replaced with a categorical paragraph.
Enrollment procedures get their own pages. platform-sdk-enrolling-a-
video-unit.md and platform-sdk-enrolling-an-access-control-unit.md
hold the workflows that previously lived at the bottom of the
respective entity pages. A developer searching for the task lands on
the procedure directly. The HID VertX secure-mode variant moves to the
access control enrollment page where it is relevant.
Source-of-truth fix caught while trimming: the RecordingProblem value
on archiver statistics lives on each ArchiverEncoderStatistics entry,
not on the disk-group level; the archiver-role example iterates
EncoderStats accordingly.
Sidebar: added "Enrolling a video unit" and "Enrolling an access
control unit" entries beside their hub-side spokes.
After all edits, every csharp block in the 14 hub/spoke pages plus the
two new procedure pages compiles cleanly against the live SDK
assemblies.