OCR-D / zenhub

Repo for developing zenhub integration
Apache License 2.0
0 stars 0 forks source link

Consolidate documentation for developers #37

Open kba opened 2 years ago

kba commented 2 years ago

Current situation

We do have documentation for developers but from the on-boarding process for phase III we've learned that it is scattered across platforms, partially out of date and lacks code examples and easy entrypoints to understand all the components of the software.

How it should be

We should have a single entry for all documentation for developers. This document should be on the website and incorporate or link to

Testing

If we provide a colleague with no prior knowledge of OCR-D with the documentationi and a few hours to try to set it all up, will she/he be able to set up a development environment where they are able to add a feature to a processor like ocrd_vandalize?