Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ocaml/v3.ocaml.org-rescript

The next implementation of ocaml.org, built on OCaml, ReScript, NextJS, and Tailwind.
https://github.com/ocaml/v3.ocaml.org-rescript

Last synced: about 2 months ago
JSON representation

The next implementation of ocaml.org, built on OCaml, ReScript, NextJS, and Tailwind.

Awesome Lists containing this project

README 

        
# v3.ocaml.org



**Status:** in development to make it feature-complete ahead of a launch

at the OCaml Workshop 2021.



This is the working repository for v3 of the ocaml.org site, and the first

major upgrade to the infrastructure since the v2 launch in 2012.  It will

feature the major following improvements when completed:



- **Integrated documentation and package management:** The v3 site will combine the

  package management (currently opam.ocaml.org) with a new central

  documentation source (codenamed 'docs.ocaml.org') for all 14000+ opam packages

  directly within the ocaml.org site.



- **Responsive and accessible:** The site design also takes into account modern

  web-design principles, restructuring the old content in accordance with methods

  that will present it more compellingly. It is a total redesign that modernises

  the look and feel of the webpage, as well as make it easier to navigate, and more

  accessible (particularly on mobile devices).



- **Separation of data editing from HTML/CSS generation:**  The v2 site combined

  (e.g.) fetching external newsfeeds with the HTML generation, whereas this v3

  site keeps a structured store of data, which is then parsed to generate the

  website.  We use ReScript/OCaml to generate the site content, and Ocurrent to

  automate the data pipelines. The data source repository is known as

  [ood](https://github.com/ocaml/ood) (OCaml.Org Data).



- **Publishing content:** There will original content on the new ocaml.org site.

  The v2 site only syndicated from external sources, but now we can publish

  editorial content from around the community directly on ocaml.org. Original

  content could include interviews, featured news stories, talks and other media

  from past conferences, along with many other types of content.



Since this site is a work-in-progress, not all of the above features are yet

materialised in this repository. As the team shows the site to more

stakeholders in the ocaml.org ecosystem, we will expand the supported

featureset.



## Team



The immediate team working on the v3 site consists of:

- Ashish Agarwal (Solvuu)

- Kanishka Azimi (Solvuu)

- Richard Davison (Solvuu)

- Patrick Ferris (OCaml Labs)

- Gemma Gordon (OCaml Labs)

- Isabella Leandersson (OCaml Labs)

- Anil Madhavapeddy (University of Cambridge)

- Thibault Mattio (Tarides)



The documentation generation portion is courtesy of the odoc

development team, with the site generation done by:

- Jon Ludlam (OCaml Labs)

- Jules Aguillon (Tarides)

- Lucas Pluvinage (Tarides)



Major decisions will be taken by an ocaml.org steering committee:

(TBD, but a sensible baseline of people to invite is below along with role

 positions. This will need to be determined as we get closer to launch)



- Ashish Agarwal (OCaml.org continuity)

- Florian Angeletti (OCaml core team)

- Gemma Gordon (OCaml.org continuity)

- Xavier Leroy (OCaml project leader and veto)

- Jonathan Ludlam (odoc maintainer)

- Anil Madhavapeddy (OCaml.org continuity)

- Gabriel Scherer (OCaml core team)

- Christophe Troestler (OCaml.org continuity)



## Contributing



There are four repositories involved in the construction of v3.ocaml.org:



- [ocaml/ood](https://github.com/ocaml/ood) is the OCaml.org data repository.

- [ocaml/v3.ocaml.org](https://github.com/ocaml/v3.ocaml.org) is the ReScript-based frontend site generator

- [ocurrent/ocaml-docs-ci](https://github.com/ocurrent/ocaml-docs-ci) is the OCurrent pipeline that

  builds the 14000 packages and prepares them for publishing online with [odoc](https://github.com/ocaml/odoc)

  and [voodoo](https://github.com/ocaml-doc/voodoo).

- [ocaml/v3.ocaml.org-server](https://github.com/ocaml/v3.ocaml.org-server) is the Dream-based server that

  serves the overall site.



Please see the [contribution guide](CONTRIBUTING.md) for information on how to

build and contribute content to this ReScript frontend.