Skip to content

Documentation: Future work and automation #121

Description

@samet-akcay

Overview

This issue tracks documentation improvements and automation for the physicalai repository.

Planned APIs (documented but not fully implemented)

  • physicalai.runtime.PolicyRuntime
  • Runtime Execution strategies (Sync, Async, Remote)
  • Runtime CLI commands: run, infer, serve
  • Config entry points: ComponentSpec, workflow config, from_config

Future Work

  • Add docs CI build
  • Add mkdocstrings once runtime and config APIs stabilize
  • Replace manual API signature pages with generated API pages
  • Generate CLI reference from parser help once CLI implementation lands
  • Generate JSON Schema for manifest and config models where useful

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

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions