WIP INTERNAL TO OCAML.ORG TEAM - DO NOT SHARE
Welcome to the August and September 2023 edition of the OCaml.org newsletter! As with the previous issues, this update has been compiled by @sabine and @tmattio.
Our goal is to make OCaml.org the best resource for anyone who wants to get started and be productive in OCaml. The OCaml.org newsletter provides an update of our progress towards that goal and an overview of changes we are working on.
We couldn't do it without all the amazing OCaml community members who help us review, revise, and create better OCaml documentation. Your feedback enables us to better prioritise our work and make progress towards our goal. Thank you!
This past two months, our priorities were:
After completing a first version of the design in July, we started working on a new iteration that is more in line with the current branding of the site. Feedback from the team and users has been extremely positive on the UX (the structure of the new documentation and the layout of the pages), but we felt that the design direction needed to be reconciled with and improve on the existing designs of all pages. Thus, we we are revisiting the designs' UI aspect in both light and dark mode.
Relevant PRs and Activities:
Since August, we've focused mainly on the "Getting Started" documents, including a guide to installing OCaml, a "tour" of the OCaml language, and a tutorial to create your first project in OCaml.
Anticipating on our October update, we've just published the new Get Started documentation pages!
We still encourage community feedback, as we fully expect to iteratively improve these docs in the coming weeks, especially as they will now serve as the primary resource to everyone who want to get up and running with OCaml.
Our focus will now shift to filling the gaps in the Language section of the documentation, starting with the Basic Data Types and Functions and Values pages, which are currently being reviewed by the community.
Relevant PRs and Activities:
This month, we're welcoming 2 new contributors:
and welcome contributions from returning contributors:
Thanks a lot to all the contributors this month! It's lovely to see more and more people making contributions to the site!
Relevant PRs and Activities:
Stdlib
build artifacts โ ocaml/ocaml.org#1469.md
files were translated to linebreaks by voodoo. Now, voodoo emits space characters for these โ ocaml-doc/voodoo#119.spec
and .spec-doc
โ ocaml/ocaml.org#1509