pyt-team/TopoEmbedX

Add tex website pages

ninamiolane opened this issue · 0 comments

What?

The current documentation website does not include TEX.
https://pyt-team.github.io/

We should add one to help contributors navigate the repository.

Why?

The documentation website is a great entry point for contributors.

Where?

Add API documentation pages in here:
https://github.com/pyt-team/TopoEmbedX/tree/main/docs

If necessary, change the docs workflow:
.github/workflows/

How?

The API should be automatically generated from the code.
Follow what is done in TNX

  • Add core of website
  • Create secrets for tex and github repos
  • Add API pages
  • Add Contributing pages