Welcome to the July 2024 edition of the OCaml.org newsletter! This update has been compiled by the OCaml.org maintainers. You can find previous updates on Discuss.
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 on our progress towards that goal and an overview of the changes we are working on.
We couldn’t do it without all the amazing people who help us review, revise, and create better OCaml documentation and work on issues. Your participation enables us to so much more than we could just by ourselves. Thank you!
This newsletter covers:
- Community-Driven Development of OCaml.org
- Recipes for the OCaml Cookbook: Help us make the OCaml Cookbook really useful by contributing and reviewing recipes for common tasks!
- Community & Marketing Pages Rework: Implementation work in progress.
- General Improvements: As usual, we also worked on general maintenance and improvements, so we’re highlighting some of the work that happened below.
Community-Driven Development of OCaml.org
After reworking most of the OCaml.org website to be more useful, more usable, and nicer to look at, the team at Tarides that has been working on OCaml.org is disbanding. However, OCaml.org will continue to be maintained and extended by by the OCaml Platform and OCaml compiler contributors, as well as by the wider OCaml community.
You can reach out to the OCaml.org maintainers to discuss any bigger changes or additions you’d like to make. Contributions to improve existing features and bug fixes are always welcome!
Open Issues for Contributors
You can find open issues for contributors here!
Recipes for the OCaml Cookbook
The OCaml Cookbook is a place where OCaml developers share how to solve common tasks using packages from the ecosystem.
A recipe is a code sample and explanations on how to perform a task using a combination of open-source libraries.
The Cookbook is live at ocaml.org/cookbook.
Here’s how you can help:
- Help review the open pull requests for cookbook recipes!
- Contribute new recipes and tasks for the cookbook!
Thank you all for the many contributions! One area where we could use help is in reviewing and improving the suggested recipes and tasks.
Relevant PRs and Activities:
- (open) PR: cookbook recipes for parse-command-line-arguments ocaml/ocaml.org#2573 by @richardhuxton
- (open) PR: Cookbook Check a Webpage for Broken Links ocaml/ocaml.org#2581 by @ggsmith842
- (open) PR: cookbook: “create and await promises”: Lwt, Async ocaml/ocaml.org#2584 by @richardhuxton
- (open) PR: CookBook: read-csv - basic example of reading records from a CSV string ocaml/ocaml.org#2589 by @danielclarke
- (open) PR: Cookbook: Email regex patch ocaml/ocaml.org#2591 by @F-Loyer
- Fixes and Improvements to existing recipes:
- PR: Update 00-uri.ml: missing arg ocaml/ocaml.org#2618 by @ttamttam
Community & Marketing Pages Rework
We have UI designs for the reworked and new pages of the community section, and implementation is being worked on by @oyenuga17, our former Outreachy intern!
Relevant PRs and Activities:
- PR: Implement new community overview page ocaml/ocaml.org#2605 by @oyenuga17
- PR: Fix typo and case inconsistencies on community page ocaml/ocaml.org#2616 by @pjlast
- PR: Redesign OCaml Planet Page ocaml/ocaml.org#2617 by @oyenuga17
General Improvements and Data Additions
Summary:
- The selected OS is now part of the anchor tag of the URL on the Install OCaml page. This allows people to link to quick install instructions for a specific OS.
- We appreciate the contributions to the OCaml documentation!
- We’re checking for backlinks to OCaml.org again with Ahrefs.
Relevant PRs and Activities:
- (open) PR: Build on OCaml 5 (ocamlnet -safe-string workaround) ocaml/ocaml.org#2609 by @aantron
- PR: Ahref tag ocaml/ocaml.org#2571 by @cuihtlauac
- PR: Issue #2583: Added OS Anchor Tags to Install OCaml ocaml/ocaml.org#2600 by @SisyphianLiger
- PR: Performance: cache search index digest until ocaml-docs-ci computes it ocaml/ocaml.org#2620 by @sabine
- Documentation
- PR: Unwrapped libraries ocaml/ocaml.org#2562 by @cuihtlauac
- PR: Explain folders bin, lib and _build ocaml/ocaml.org#2568 by @cuihtlauac
- PR: Use
layout opam
in.envrc
in opam path doc ocaml/ocaml.org#2597 by @smorimoto - PR: Use sudo in install tutorial ocaml/ocaml.org#2558 by @cuihtlauac
- PR: Add documentation about comments to Tour of Ocaml ocaml/ocaml.org#2613 by @NoahTheDuke
- PR: Fix Example referencing Type not yet Defined ocaml/ocaml.org#2606 by @avlec
- Refactor + Code health:
- PR: Open Data_intf in data.mli ocaml/ocaml.org#2563 by @cuihtlauac
- PR: Make data error file path copy-paste ready ocaml/ocaml.org#2567 by @cuihtlauac
- PR: Test ocaml/setup-ocaml v3 ocaml/ocaml.org#2570 by @cuihtlauac
- PR: Update ocaml/setup-ocaml to v3 ocaml/ocaml.org#2565 by @smorimoto
- PR: Refactoring parts from PR #2443 ocaml/ocaml.org#2576 by @cuihtlauac
- PR: Bump peter-evans/create-pull-request from 5 to 6 ocaml/ocaml.org#2588 by @dependabot
- PR: Set OCaml to 4.14.2 ocaml/ocaml.org#2587 by @cuihtlauac
- PR: fix: write directory instead of folder ocaml/ocaml.org#2572 by @ashish0kumar
- PR: sync debug-ci and ci ocaml/ocaml.org#2582 by @cuihtlauac
- Data
- PR: changelog: dune 3.16.0 ocaml/ocaml.org#2566 by @emillon
- PR: (data) add OCaml.org newsletter June 2024 ocaml/ocaml.org#2575 by @sabine
- PR: Add changelog for the latest merlin releases ocaml/ocaml.org#2580 by @voodoos
- PR: Add changelog for the latest ocaml-lsp release ocaml/ocaml.org#2593 by @PizieDust
- PR: Add missing changelog for opam 2.2.0 ocaml/ocaml.org#2598 by @kit-ty-kate
- PR: Add changelog entry for ppxlib.0.33.0 release ocaml/ocaml.org#2615 by @NathanReb