I believe managing the project's documentation requires additional effort. We could reduce this effort by referencing the respective repositories to their sections.
Implementation considerations
This feature proposal is to lighten the efforts for maintaining the documentation by directly delivering the changes to the respective repositories. I think additional improvements can be observed after this setup.
The Mardown files of the docs folder in other repositories usually fall under the same section in the documentation website. We could set up the conf.py to pull the data from these directories to perform a runtime compilation of the documentation during CD.
This setup usually uses the same information on both ends. The docs folder of the respective repositories can be independently referred to and through the documentation website.
The coding examples for the documentation can still use .rst with references being made to the scripts. This can go into this repository for running CI tests.
Maintaining milestones-based documentation will be easier in my opinion considering the one-to-one relations between all the repositories.
Feature description
I believe managing the project's documentation requires additional effort. We could reduce this effort by referencing the respective repositories to their sections.
Implementation considerations
This feature proposal is to lighten the efforts for maintaining the documentation by directly delivering the changes to the respective repositories. I think additional improvements can be observed after this setup.
docsfolder in other repositories usually fall under the same section in the documentation website. We could set up theconf.pyto pull the data from these directories to perform a runtime compilation of the documentation during CD.docsfolder of the respective repositories can be independently referred to and through the documentation website..rstwith references being made to the scripts. This can go into this repository for running CI tests.