Landing spot for summarizer input descriptions

[marcverhagen]

There are some notes in the inspector repository on the input to the summarizer at https://github.com/clamsproject/mmif-inspector/blob/main/docs/developer-notes.md.

Since that repository is not about the summarizer anymore I want to move them and I am collecting candidates for landing spots. I see two candidates in this repository:

• a new docs directory inside the summarizer package
• the mmif-python documentation.

Any other candidates?

[keighrim]

My two cents;

If the material is purely for developers, dump as in-line comments in the code itself. Separate files means additional maintenance. (Or even as a new section in the CONTRIBUTING.md)

If the material is for users too, properly format into rst syntax and add as a docstrings in the code.

1. Again, separate files (md files under .../subpackage/docs or a rst file under documentation) mean additional maintenance.
2. Sphinx will take care of properly render HTML pages for users/readers