OCaml.org Newsletter: October 2023
Welcome to the October 2023 edition of the OCaml.org newsletter! This update has been compiled by the OCaml.org team. 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 OCaml community members who help us review, revise, and create better OCaml documentation. Your feedback enables us to better prioritize our work and make progress towards our goal. Thank you!
This month, our priorities were:
- Learn Area: We continue our efforts to make OCaml.org a great resource for learning OCaml. This month, we've validated a new version of the designs for the Learn area, and we've published two new documentation pages!
- Outreachy Internship Application Period: OCaml.org is participating in the Outreachy Internship Program with two internship projects. As part of the application period, we've received tons of fantastic contributions from Outreachy applicants!
- General Improvements: As usual, we also worked on general maintenance and improvements based on user feedback, so we're highlighting some of our work below.
Learn Area
1. Redesign of the Learn Area
After going back to the drawing board on the new designs for the Learn area, we've designed a new version of the landing page, alongside updated variants of the Community and Package landing pages, to ensure they are visually consistent. We've validated the new design direction and will be updating the designs for the rest of the Learn area pages next. Once the designs are available for all the pages, we'll be ready to start implementing them. We're very excited to get the new version of the pages live; we hope you are too! Stay tuned!
| Learn | Community | Package | | -------- | -------- | -------- | | | | |
Relevant PRs and Activities:
- Continued work on Figma UX/UI designs for the new Learn area
- Books page redesign - ocaml/ocaml.org#1536
- Added a short description to all exercises ocaml/ocaml.org#1681
- Collapse tab navigation to breadcrumbs for mobile view on learn area - ocaml/ocaml.org#1541
2. OCaml Documentation
Last month, we announced the publication of the new Get Started documentation. After publishing this section, we're turning our focus to the Language section of the documentation.
This month, we've published two new documentation pages: Basic Data Types and Functions & Values. Together, they teach the basics of OCaml from the very beginning, starting with what a value and a function are. Having witnessed newcomers such as Outreachy interns struggle to learn OCaml from the OCaml.org documentation because it required a lot of prior programming knowledge, we're excited to have this new content available for Outreachy interns and all newcomers. This is a first version of the pages, and we've already received excellent feedback to improve it. Don't hesitate to share more, whether you're a beginner struggling to get up and running, or an OCaml developer with opinions on how we should teach OCaml!
We're currently reviewing two other documentation pages on Mutability and Polymorphic Variants. They should be ready for community review soon.
Stay tuned, and please, keep the feedback on the new documentation coming; it's been a blast to see so much engagement from the community!
Relevant PRs and Activities:
- In Progress:
- Sets
- Maps
- In Review (internal):
- In Review (community):
- Published:
- Basic Data Types (see Discuss Thread)
- Functions and Values (see Discuss Thread)
- Installing OCaml (see Discuss Thread)
- A Tour Of OCaml (see Discuss Thread)
- Your First OCaml Program (see Discuss Thread)
- Introduction to opam Switches
- Fix Homebrew Errors on Apple M1
- Operators
- Error Handling (see Discuss Thread)
- Arrays (see Discuss Thread)
- Sequences (see Discuss Thread)
Outreachy
OCaml.org is participating in the Outreachy Internship Program. Outreachy provides internships to people subject to systemic bias and impacted by underrepresentation in the technical industry where they are living.
A substantial part of this month has been spent on creating issues, reviewing pull requests, and mentoring Outreachy applicants on the OCaml Discord server.
The contributions include small fixes, implementing Figma designs, and small feature additions. Notably, the OCaml Changelog now has an RSS feed, and some outstanding designs for the package area have been applied.
8 out of the 21 medium difficulty issues have been completed in October, while only 6 out of 30 simple outreachy issues remain open. For the remaining issues, we will support the contributors in finishing their work, and free any abandoned issues so that community members can pick them up.
Relevant PRs and Activities:
- Opened 30 simple issues tagged "outreachy", and 21 issues tagged "outreachy-medium"
- Refactor + simplify learn layout in preparation for new footer - ocaml/ocaml.org#1590
- @ademolaomosanya contributed: Rearranged and changed links in footer - ocaml/ocaml.org#1616
- @IdaraNabuk contributed: Update Tailwind Configuration to Resolve Warnings - ocaml/ocaml.org#1620
- @oyenuga17 contributed: Add a RSS feed for changelog - ocaml/ocaml.org#1593
- @sophiatunji contributed: Renamed "problems" with "exercises" in filenames and codebase - ocaml/ocaml.org#1592
- @kalio007 contributed: Add a "Standard Library API" link to the mobile navigation menu - ocaml/ocaml.org#1600
- @RWUBAKWANAYO contributed: Fix search bar on medium-sized screens - ocaml/ocaml.org#1665
- @shyusu4 contributed: Fix jump to definition on in-package search for Safari - ocaml/ocaml.org#1634
- @FatumaA contributed: Fix horizontal scrolling on ocaml ecosystem section of homepage - ocaml/ocaml.org#1668
- @AndroGenius-codes contributed: Applied new design for Package Search Dropdown - ocaml/ocaml.org#1608
- @henilGondalia contributed: Applied New Styles to Package Documentation Module Navigation - ocaml/ocaml.org#1638
- @Girish-Jangam contributed: Paginate package search results - ocaml/ocaml.org#1657
- @sophiatunji contributed: Fixed js-of-ocaml link on home - ocaml/ocaml.org#1707
- @Burnleydev1 contributed: Add Abongwa's summer internship info - ocaml/ocaml.org#1647
- @RWUBAKWANAYO contributed: Add link to English edition of the book "Développement d'applications avec Objective Caml ocaml/ocaml.org#1659
- @AryanGodara contributed:
- Add Blog Post for Outreachy Summer internship, Summer'23 - ocaml/ocaml.org#1649
- Add Blog link in the summer internship post - ocaml/ocaml.org#1703
- @mohdaquib171 contributed: Tutorial Bottom Section Styles (#1603) ocaml/ocaml.org#1617 - status: waiting for completion of another issue
- @IdaraNabuk contributed: Add Capability for a Book Entry to have Multiple Languages - #1666 ocaml/ocaml.org#1679
- @oyenuga17 contributed: Add a Jump To Top Button ocaml/ocaml.org#1702
- @sophiatunji contributed: Learn Area Footer Redesign - ocaml/ocaml.org#1645
General Improvements
This month, we’re welcoming 1 new contributor:
- @davesnx changes 'Unknown documentation status' from
a
to aspan
- ocaml/ocaml.org#1628
Relevant PRs and Activities:
- We now log a message instead of crashing when failing to parse the opam file - ocaml/ocaml.org#1575