Create new Enso documentation viewer #8
Description
Project summary
The public-facing documentation site will be a static site generated using a static site generator and hosted using GitHub Pages (or an alternative such as Netlify). The advantage of this is:
- Low maintenance: the static site does not require maintaining any servers or provisioning any services on cloud hosting. There is no application to fail or update.
- Speed: Serving static files is fast, there is no server side rendering or API requests to introduce performance overhead for a user.
- GitOps: New content can be added and managed via typical development workflows, integrated with normal day-to-day dev work via GitHub actions.
The developer documentation site uses a version of this process. Whilst the devdoc site has some requirements that the public facing docs do not (low impact on the docs writers, aka developers), the process will be much the same.
To integrate the Standard Library documentation with such a static site, using the Javascript parser/generator, the suggested method would be:
- A GitHub Action triggered on new release builds on github.com/enso-org/enso,
That calls the JS parser on the standard library files, parsing the included doc comments,
Generates static output, either HTML or markdown,
And pushes the resulting files to another repository that serves as the source for the end static site.