Skip to content

[PRD4] Document migration, compatibility, and release gates #19

Description

@Vonng

Part of #11. Depends on #14, #15, #16, #17, #18, and consumer integration pgsty/oink.pgsty.com#3.

Outcome

Ship migration guidance, configuration reference, compatibility guarantees, and release evidence for PRD 4.

Scope

  • Document native Hugo menu nesting and the one-level/deep-menu contract.
  • Document sidebar icon policy and the pre-1.0 compatibility default.
  • Document search fields, alias precedence/deprecation, cascade inheritance, schema fallbacks, and index-size implications.
  • Document built-in and custom command configuration, localization, allowed execution kinds, and security constraints.
  • Publish keyboard/screen-reader interaction tables and no-telemetry/runtime-gating guarantees.
  • Update starter-site examples separately from the theme compatibility default.
  • Record visual, unit, integration, CI, and hosted-delivery gates as distinct evidence.

Acceptance criteria

  • English reference is complete and Simplified Chinese coverage is equivalent.
  • Migration examples work under root and subpath deployment.
  • Compatibility aliases include a removal window tied to a future major release.
  • Release checklist links to passing theme and consumer regression evidence.
  • No feature is documented as available before its owning PR is merged and released.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationprd4PRD 4: nested navigation and Command Palette

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions