Skip to content

Update the MORYX Framework and Modules documentation #627

@1nf0rmagician

Description

@1nf0rmagician

The repository need an extensive update to the documentation. The following topics should be tackled

  • Unify the documentation of the different modules
    While several modules still contain an overview page with deprecated lists of facades the newer once don't
  • Add documentation for the public APIs of the different modules
    All modules have separate packages for their public APIs and the implementation of the business logic we provide, e.g. Moryx.Simulation and Moryx.Simulation.Simulator.
  • Add user stories describing the functionality of each of the modules from the perspective of different stakeholders, especially the application developer and the operator
    While the e.g. the Orders modules contains a multitude of configuration options in the Command Center and is highly extendable, these features are not sufficiently documented
  • Update the documentation for the MORYX architecture and the models and naming pattern used for its components
  • Update the documentation for creating database connections within modules
  • Update all references in the documentation
  • Recover the DI documentation deleted here , according to @dbeuchler most is still correct and relevant. But it needs some cleaning up
  • The documentation for the dependency injection does not mention that the Level 1 container is the service collection. This context should be given somewhere and the docuemntation needs to be properly linked in the documentation structure for MORYX 10
  • Add basic instructions on how to setup each of the modules starting with which package references to include
  • Write tutorial "How to create a Cell" -> reference ADP and give some context
  • Add introduction in article 'What can I do with the process engine'
  • Update Architecture and Runtime documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions