OpenSimulationInterface / osi-utilities

Utility library for reading and writing OSI trace files supporting different container formats.
Mozilla Public License 2.0
0 stars 0 forks source link

Doc: Integrate into OSI Docu #3

Open jdsika opened 4 hours ago

jdsika commented 4 hours ago

We need help from @philipwindecker to integrate the API Doxygen docu and an opinion. Maybe deploy first in this repo and then later integrate?

philipwindecker commented 2 hours ago

I'll check with the office regarding budget and get back to you next week.

pmai commented 2 hours ago

I don't think this should be integrated into the OSI documentation. This is a stand-alone open source software module and not part of the standard, hence no need to confuse people. There will just be a pointer to this package in non-normative text of the standard, and that's it.

Any further integration would make this part of the standard release process, and we do not want that, among other things.

pmai commented 2 hours ago

@philipwindecker see my comment above; I think if anything then this needs its own documentation work, and we'll have to see how to fund that if needed, but right now I would keep this at arms length from the standard (similar to checker bundles vs. standards).

philipwindecker commented 2 hours ago

Ok, let me know when/if you'd like my support on this in the future, then. :)