You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Since various properties in the different modules/extensions change or are added due to new functionality, it takes more time to document these manually at present. However, the description of the properties is necessary for developers and users of the EDC so that it can be configured and understood correctly.
Automatic generation of documentation is required for this purpose.
Note: @paullatzelsperger has already started with a poc, with the following functionality -> please contact him if you have further questions.
modules and dependencies are parsed recursive
in each file the parser loos for specific annotations which describe a property (description, default value…)
the information is extracted in a json file
the json file is transformed to a md file like this (just an example) tractusx-edc.md
Why
Since various properties in the different modules/extensions change or are added due to new functionality, it takes more time to document these manually at present. However, the description of the properties is necessary for developers and users of the EDC so that it can be configured and understood correctly.
Automatic generation of documentation is required for this purpose.
Note: @paullatzelsperger has already started with a poc, with the following functionality -> please contact him if you have further questions.
tractusx-edc.md
What
The text was updated successfully, but these errors were encountered: