@sbidoul we can discuss here the implementation of the bot work.
Current plan:
When a PR is merged, it should get to this repo and check if that module has docs.
If there are no docs, then it should generate the module docs here directly.
If it has docs, (or if it didn't have but now it has because of the previous step) then it should:
Remove these fragments:
CONFIGURE
CONTEXT
USAGE
DESCRIPTION
INSTALL
Add a basic DESCRIPTION fragment that just points to the docs URL. The URL must be written directly, so users browsing the README from Odoo Apps store can copy the URL and paste it in the browser (because they remove any links).
The goal is that the single source of truth for a module docs should be found here, but we wouldn't want to force developers to open 2 PRs when proposing a new module.
Notice that, when the PR alters the module behavior and thus the README needs an update, yes they will need to open 2 PRs. But the 2nd one can be done by someone else (hopefully a functional person).
@sbidoul we can discuss here the implementation of the bot work.
Current plan:
The goal is that the single source of truth for a module docs should be found here, but we wouldn't want to force developers to open 2 PRs when proposing a new module.
Notice that, when the PR alters the module behavior and thus the README needs an update, yes they will need to open 2 PRs. But the 2nd one can be done by someone else (hopefully a functional person).