Docs: API and Documentation

[jspenger]

We should have the API and documentation be conveniently be available.

A first suggestion is to use scaladoc to generate both the API docs and the documentation docs. See, e.g., https://github.com/lampepfl/dotty/tree/main/docs and https://dotty.epfl.ch/.

[jspenger]

The docs should be hosted on https://docs.portals-project.org, see #14 to enable URL.

[jspenger]

To publish the docs we have to do the following steps (once it is public):

• add release and tag: v0.0.1
• set this repository to public, and set the portals-api repository to public, enable github pages for both repositories
• enable the github action workflow: Generate and deploy API documentation
• set the urls to point api.portals-project.org
• enable https

[jspenger]

I'll close this issue for now, as the api is now live. Instead, I will create two separate issues, one for launching the versioned api docs (once we have proper version), and one for creating a docs using scaladocs.