In 2024, and with all the improvements that GitHub has included in terms of documentation and markdown, does it still make sense for RtD documentation to be mandatory? Maintaining it is an extra effort that doesn't always make sense.
The clearest example is the Orion Context Broker documentation. This was simplified exponentially when the single page document was made. In this case, the RtD documentation does not make as much sense, and often provides old or outdated versions when it appears on google.
For that reason, we think this requirement:
|
- Accurate, current Documentation **MUST** be available on Read the Docs and as GitHub content. |
Should be changed to something like this:
- Accurate, current Documentation MUST be available on Read the Docs OR as GitHub content.
In 2024, and with all the improvements that GitHub has included in terms of documentation and markdown, does it still make sense for RtD documentation to be mandatory? Maintaining it is an extra effort that doesn't always make sense.
The clearest example is the Orion Context Broker documentation. This was simplified exponentially when the single page document was made. In this case, the RtD documentation does not make as much sense, and often provides old or outdated versions when it appears on google.
For that reason, we think this requirement:
contribution-requirements/README.md
Line 44 in e14a201
Should be changed to something like this: