reasonml.org

This is the repository for reasonml.org and is currently work in progress.

Setup

yarn

# Initial build
yarn bs:build

yarn dev

# Open localhost:3000

In case you want to run BuckleScript in watchmode:

yarn run bs:start

Build Index Data

We are parsing our content for specific index data (such as, all interesting search terms we need for searching inside the Belt docs). You can create your index by running following command:

yarn run update-index

All the index data is stored in index_data, but will not be tracked by git. Make sure to build the index after a fresh clone, otherwise Next might not build specific pages (file index_data/x.json not found).

Run Tests

We try to verify our code examples inside markdown files as much as possible. Currently we are using scripts/test-examples.js to test all our example codeblocks (those blocks marked with re examples).

After writing documentation, make sure to run this code before submitting a PR:

# Tests all files
node scripts/test-examples.js

# Or just a subset (glob pattern)
node scripts/test-examples.js "pages/apis/latest/belt/set-*.mdx"

Design / UX

Design mockups can be found here.

Be aware that some screen designs might still be work in progress, if you have any design / UX questions, either comment directly on the design tool as guest, or open an issue.

Useful commands

Build CSS seperately via postcss (useful for debugging)

# Devmode
postcss styles/main.css -o test.css

# Production
NODE_ENV=production postcss styles/main.css -o test.css

URL Route Design

This is an attempt to formalize the URL structure of this website

API related urls

By convention, NextJS uses pages/api for server related functionality, so we need to fall back to pages/apis instead.

/apis/javascript refers to all BuckleScript related APIs.
/apis/javascript/latest refers to the overview of all JavaScript related modules on the latest version
/apis/javascript/x.x.x refers to the overview of all JavaScript related modules on the x.x.x version
/apis/javascript/latest/list refers to Belt's List module on the latest version

Examples:

/apis/javascript/latest (overview)
/apis/javascript/latest/belt
/apis/javascript/latest/js
/apis/javascript/latest/node

/apis/javascript/6.2.1 (overview)
/apis/javascript/6.2.1/node
/apis/javascript/6.2.1/belt

/apis/ (overview / version independent)

Contributing

Check out our CONTRIBUTING.md for how to get started working on this project.

TLDR: Read and comply to our Code of Conduct; always make sure to have an issue assigned / create issues / join us in the ReasonML Discord #docs channel to find a good task to work on.

montogeek / reasonml.org