Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup the repository to link the docs of other repositories directly. #39

Open
franklinselva opened this issue Oct 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@franklinselva
Copy link

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.

  • 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.
@franklinselva franklinselva added the enhancement New feature or request label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant