finos / finos/tracdap

Documentation for platform developers (python runtime)

Open
#37 0 comments 0 reactions 0 assignees View on GitHub
documentation runtime-python
Dominant language
Java
Stars
55
Forks
18
Avg merge
6h 29m
Merged PRs (30d)
16

Description

Should include overview of the key components of the runtime, the execution flow and design principals in wiki format. Also at least a paragraph of inline documentation at the module and class level.

Particular focus should be given to extending the runtime with storage and model repo plugins. A dedicated wiki page with more "public-facing" documentation for the key interfaces and bits of framework around these plugin mechanisms.

Contributor guide

Open the contributing guide

Research direction

Start by mapping the Python runtime's key components and execution flow, then inspect the module and class boundaries and the storage and model repo plugin interfaces. Done means a wiki overview covers the architecture, flow, design principles, and public plugin mechanisms, with module- and class-level inline documentation added.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.