TopoModelX icon indicating copy to clipboard operation
TopoModelX copied to clipboard

Make unique doc website for the three packages

Open ninamiolane opened this issue 9 months ago • 8 comments

What?

Create a pyt-team website that serves as a single entry point that points towards the three documentation websites.

Why?

Users might want to circulate from one doc website to the other. Having one single entry point could help.

How?

  • [ ] Create a docs folder with the content of the website. See /docs folder in the PR referenced below.

  • [ ] Create a github action workflow that builds and deploys the content of the docs folder into a website. See .github/workflow/docs.yml in the PR referenced below.

  • [ ] Use Pyt-Team image as a welcome banner.

  • [ ] Make sure that the formatting of the website is intact.

  • [ ] On each package's doc website, create an option to go to the others: e.g. on TopoNetX's website, create an option to go to TopoEmbedX and TopoModelX, etc.

Image

ninamiolane avatar Sep 19 '23 16:09 ninamiolane