ocrd network documentation circle linking
joschrew opened this issue · comments
In the ocrd_network-package-readme it says go to ocr-d-core for further information and vice versa.
Do we already have information about that? Otherwise we need to at least provide something in the ocrd_network readme.
The README file was added prematurely to ocrd_network. It serves no purpose currently. Honestly, I don't see any value in updating that now when many things are still constantly changing. Keeping the README file up-to-date will require extra effort that can go to more important tasks. However, at some point, we need to provide that when the ocrd_network is mature enough.
I wondered if we already have written down something regarding the ocrd_network or processing server, what we could simply link there. I know we have the config-spec Triet wrote, but I am rather looking for something with sentences and words not technical yaml files. At least I would then remove the circle linking and just write something like "TODO: add useful info here" instead of linking back and forth.
Not sure what is good.
I know we have the config-spec Triet wrote, but I am rather looking for something with sentences and words not technical yaml files.
Should I mention that the config spec is no longer up-to-date after adding the Processor Server option in #1030? I am not even sure the extension of the config is good enough in its current form. No matter what we write now, will be outdated fast.
Documentation is important and the README will become relevant once we start publishing to PyPI but for now, I would really focus on the implementation and just leave a big warning at the beginning of the README.md that development is ongoing and changes can be swift. Then let's update once things have settled down.