openvinotoolkit / openvinotoolkit/physicalai
Documentation: Future work and automation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 22
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 30
Description
Overview
This issue tracks documentation improvements and automation for the physicalai repository.
Planned APIs (documented but not fully implemented)
-
physicalai.runtime.PolicyRuntime - Runtime
Executionstrategies (Sync, Async, Remote) - Runtime CLI commands:
run,infer,serve - Config entry points:
ComponentSpec, workflow config,from_config
Future Work
- Add docs CI build
- Add
mkdocstringsonce 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the planned PolicyRuntime, execution strategies, CLI commands, and configuration APIs, then clarify which documentation or automation item is ready; completion should be defined for one specific item, such as a docs CI build or generated API reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100