Proposal for intended usage

[giorgiop]

The repo must be configurable as a GitHub action callable in a workflow.

Direct mode:

• a workflow inside a code repo x is called (manual or automated trigger)
• it opens a PR inside repo x, which documents every file having no documentation

Watcher mode:

• a new repository e.g. x-docs is created manually
• at first, x-docs is a clone of x
• a workflow inside X-docs looks for updates on repo X and it creates documentation for any new changes. PRs are open in x-docs
• the idea is that developers of x can read x-docs documentation, without worrying about the documentation PRs