Create new Enso documentation viewer #8
Labels
Category: Appearance
The appearance of the viewer
Category: Build
Build and deployment
Category: Documentation
Project documentation
Category: Functionality
The viewer functionality
Change: Breaking
A change that will break a public API or user-facing behaviour
Difficulty: Core Contributor
Should only be attempted by a core contributor
Priority: Highest
Should be completed ASAP
Size: Large
Requires a large time commitment
Type: Enhancement
An enhancement to Enso
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:
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:
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.
The text was updated successfully, but these errors were encountered: