Skip to content

Sweep framework parity, dashboard mounting, and operator UI documentation #370

Description

@niteshpurohit

Summary

Perform a final documentation sweep focused on framework parity, the packaged dashboard delivery model, Kaal-backed recurring-job integration, and standards support.

Scope

  • framework parity documentation for Rails, Sinatra, Roda, and Hanami
  • packaged dashboard mounting, asset delivery, and theme behavior documentation
  • operator UI guidance that matches the implemented cross-framework experience
  • documentation for how Karya uses Kaal as the recurring and cron scheduling subsystem, including framework and backend expectations
  • documentation for OpenTelemetry support, structured logs, Prometheus/OpenMetrics-compatible metrics export, and W3C Trace Context-style propagation, including how those signals relate to the operator dashboard and external tooling
  • documentation for standards-based API contracts, identity integration including concrete SAML support, CloudEvents-based outbound events, error envelopes, health/readiness surfaces, and filtering/pagination conventions where those are part of the supported product surface
  • documentation for policy-engine interoperability expectations where applicable

Acceptance Criteria

  • framework-specific setup, dashboard behavior, recurring-job integration, and standards support are documented consistently
  • documentation reflects the shared packaged dashboard model rather than framework-specific UI forks
  • operator-facing guidance matches the implemented UI, mount behavior, Kaal-backed recurring scheduling model, and standards-facing contracts

Activity

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

    No labels
    No labels

    Type

    Projects

    • Status
      Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions