How to properly place the documentation for the library?

Question

Project management

I have a library and it is located in one repository, next to it is documentation in md files. I want to make a website with examples and documentation. This is a different, private repository. Here I do not really understand how to properly resolve this moment.

There is an idea, just make a cron request for a guide and if there are new ones, then download the files and convert them to html pages. What do you think?

Answer 1

just make a cron request for a guide

Github has actions with which you can update the documentation for each commit.

then download the files and convert them to html pages.

There are already ready-made tools for this, for different languages: doxygen, gitbook, docfx, etc.
Probably, there is already a ready-made html generator for your language based on comments in the code.