sakha002 / sakha002.github.io

0 stars 0 forks source link

What should be added regarding the projects #11

Open sakha002 opened 3 years ago

sakha002 commented 3 years ago

docs, repo link? some md/rst linked in the target repo?

sakha002 commented 3 years ago

so currently the Tutorials Subpage has One page under it, which is the python tutorials page, which is an RST file in that website repo.

A lil reminder: After Writing Stuff on the RST, I shall need to compile them with sphinx maybe some changes to the python configs but mostly updates on the RST

Python Tutorials is Now A Docs Page Under Website BUT it could (and maybe should) be a Docs page under ITS own Repo.

So One question is that If I wanted to have a link from the Tutorials Page Here to the Docs Page of the other Repo, How and If that could be done? Is it going to be too difficult? can I think of an automation process?

Another Question is that maybe for now, just focus on a simple option.

I could provide the link to the python tut main repo. (no need to go deep into each section of it separately) (maybe one option would be that later I place a link for each separate Docs page?

There could certainly place a very cool CICD to compile and create the sphinx pages, from the Comments and documentations, sparced in that repo. Then I would do the SetUp Once and then afterwards with Each Commit All the Documentation would be updated.

As much as i want to dive into that cool setup, I just had a general agenda from this. I wanted to direct the folks into the python repos and docs.

I could do that in several steps

So now I think the step 0 would be just place the Repo link (maybe I don't even need to have an RST page for python Tutorials) for both python and docker pages.

Maybe a little step after that would be to try to provide some general descriptions.