Skip to content

Publish MP Catalog and API Documentation Wave B #22

Closed

Description

@davidalucas

Outcome

Publish the documentation-first contract for MP Catalog Wave B: disposition every retained command in the included top-level SA groups, populate their grouped catalog pages, and define the gRPC, .NET, Python, and JavaScript/TypeScript APIs for every command selected for Briosa support.

This issue owns one substantial Docusaurus PR and completes the exact-target catalog disposition. Proposed APIs remain marked Next until the coordinated server and client implementations are released.

Included top-level SA groups

  • Cloud and Mesh Operations
  • Construction Operations
  • GD&T Operations
  • Instrument Operations
  • Relationship Operations (remaining 59 exact-target observations)
  • Robot Calibration Appliance Node Operations
  • Robot Operations

Relationship Operations boundary

Wave A owns the 55 exact-target Relationship Operations contracts already published in briosa-docs#16 and implemented through spatialanalyzer/briosa#154. Wave B dispositions and implementations cover only the remaining 59 observed Relationship Operations commands.

Scope

  • Publish a catalog entry for every not-yet-published retained command identity in the seven included groups, including the remaining 59 Relationship Operations observations.
  • Record Current, Next, Undecided, Uncommitted, Excluded, or SDK Unavailable disposition; rationale; validation qualifier; and alternative/workaround where applicable.
  • Define gRPC and all three idiomatic client APIs only for commands selected for implementation.
  • Preserve the exact-target SA group hierarchy for navigation without turning group names into public API namespaces.
  • Complete catalog navigation and filtering for the full retained 1,412-command inventory.
  • Represent planned Wave B operations as Next and reconcile Wave A entries with their released state.
  • Keep documentation data isolated from server, protocol, client, runtime-policy, and package builds.

Acceptance criteria

  • Every retained Wave B command has a complete public disposition and grouped-page entry.
  • Unsupported commands explain why and provide a workaround, alternative, or none-known statement.
  • Every selected command has mechanically traceable gRPC, .NET, Python, and JavaScript/TypeScript API documentation.
  • Every one of the 1,412 retained command identities now has a final disposition; Undecided reaches zero.
  • No API page is created for an Uncommitted, Excluded, or SDK Unavailable command.
  • Proposed APIs are visibly Next and cannot be mistaken for released support.
  • Node.js 24 build, link, formatting, catalog-completeness, responsive-layout, and accessibility checks pass.

Coordinated implementation

Parent: #13

Activity

  1. added a commit that references this issue on Aug 23, 2026
    9325196
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions