portals-project / portals

Portals is a framework for stateful serverless apps, unifying dataflow streaming with actors
https://www.portals-project.org/
Apache License 2.0
19 stars 2 forks source link

Portals Docs #219

Open jspenger opened 1 year ago

jspenger commented 1 year ago

There should be some place for docs, where we can collect in-depth information about the project.

A suggestion is to use scaladoc to generate the documentation docs. This also makes sense as we already are using scaladoc for our api docs. The docs should be hosted on https://www.portals-project.org/docs. See for example how we are hosting the api in the api repo.

However, I have not yet succeeded in generating docs. It should be possible, we can look at other examples for this: https://github.com/lampepfl/dotty/tree/main/docs and https://dotty.epfl.ch/.