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

Make unique doc website for the three packages #211

Open
4 of 5 tasks
ninamiolane opened this issue Sep 19, 2023 · 8 comments
Open
4 of 5 tasks

Make unique doc website for the three packages #211

ninamiolane opened this issue Sep 19, 2023 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation high-priority

Comments

@ninamiolane
Copy link
Collaborator

ninamiolane commented Sep 19, 2023

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 ninamiolane self-assigned this Sep 19, 2023
@ninamiolane
Copy link
Collaborator Author

Started in : pyt-team/pyt-team.github.io#14
The files have been removed because it broke the format of the three other websites.

@ninamiolane ninamiolane added the documentation Improvements or additions to documentation label Sep 20, 2023
@ninamiolane
Copy link
Collaborator Author

@devendragovil any update on this?

@devendragovil
Copy link
Collaborator

@ninamiolane Sorry, I had been down due to illness, I have started working now, and I will finish this by Friday.

@ninamiolane
Copy link
Collaborator Author

@devendragovil any update on this?

@devendragovil
Copy link
Collaborator

@ninamiolane I have been working on this issue, and I have been stuck at various points. One big issue that I am facing is achieving the last point in the main issue thread i.e. that the three libraries are navigable from each others doc pages. Can I first raise a PR implementing perhaps the other points? I am still experimenting with the method to achieve the final bullet point.

@USFCA-MSDS
Copy link
Contributor

@devendragovil any update on this? We need to submit asap. Thanks!

@devendragovil
Copy link
Collaborator

I have merged my PR, you can check pyt-team.github.io now.

There are still a couple of issues left that I am trying to figure out.

@devendragovil
Copy link
Collaborator

@mhajij @ninamiolane Please have a look and please let me know your suggestions and any changes you would want me to make.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation high-priority
Projects
None yet
Development

No branches or pull requests

3 participants