Skip to content

Refine the MP catalog information architecture and grouped-page layout #18

Closed

Description

@davidalucas

Outcome

Refine the content-first information architecture and page layout for the SpatialAnalyzer 2026.1.0529.7 MP command catalog before expanding it across the complete retained inventory.

The result should preserve SpatialAnalyzer's exact-target command hierarchy and prove the layout through real documentation pages. It should not establish a permanent metadata model or validation framework.

Established grouping rule

The maintainer-provided exact-target SDK command outputs encode SpatialAnalyzer's command hierarchy in their filenames:

  • Split the filename stem on underscores.
  • The first segment is the root command group.
  • Each later segment is the next subgroup level.
  • Expand the compact filename labels for display without changing their hierarchy.

For example, ConstructionOperations.txt represents Construction Operations, while ConstructionOperations_BSplines.txt represents Construction Operations / B-Splines.

This exact-target SA hierarchy is the primary catalog organization. User-workflow guides may link across groups later, but they must remain secondary navigation rather than replace or flatten SA's grouping. Category paths inferred from installed-documentation evidence must not be silently substituted where they differ from the SDK filename hierarchy; those differences need explicit review.

Scope

  • Review the retained inventory's real group sizes, hierarchy depth, and duplicate MP names.
  • Document and apply the filename-derived exact-target SA grouping rule without creating one page per command.
  • Improve the catalog overview, exact-target navigation, group summaries, command sections, status presentation, local navigation, and links to operation guidance.
  • Keep support status explicit without relying on color alone.
  • Exercise the layout with representative small, large, root, and nested SA command groups.
  • Provide a compact view of the complete filename-derived hierarchy so readers can orient themselves before every command is dispositioned and published.
  • Keep grouped pages readable on narrow screens, at high zoom, and with keyboard and screen-reader navigation.
  • Keep the information architecture easy to revise as disposition work progresses.
  • Use ordinary Markdown/MDX, Docusaurus navigation, and focused presentation styles only.
  • Defer permanent metadata schemas, generated indexes, search/filter implementation, and catalog-specific completeness validation.

Acceptance criteria

  • The filename-derived exact-target SA grouping rule is documented and applied to representative real catalog pages.
  • The structure handles small, large, root, and nested groups without placing individual commands in the global sidebar.
  • The complete filename-derived group hierarchy is visible without presenting SDK observations as supported Briosa operations.
  • Each published command is easy to locate within its group and has a direct heading link.
  • Status, rationale, alternatives/workarounds, evidence links, and supported-operation links have a consistent readable presentation where applicable.
  • Status meaning is understandable without relying on color alone.
  • The catalog overview and exact-target navigation remain usable as additional groups are added.
  • Workflow navigation is treated as an optional secondary cross-link layer, not as the canonical command hierarchy.
  • Differences between SDK-output and installed-documentation group paths are reserved for review instead of silently normalized.
  • The implementation introduces no permanent command-data schema, generated catalog, search/filter system, or catalog-specific validation framework.
  • Node.js 24 build, link, responsive-layout, keyboard, and accessibility checks pass.

Parent: #13
Depends on: #14
Unblocks: #15 and #16

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions