melange-community / melange-community/jsonkit

document why the ppx can't be the same for melange and native

Open
#54 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
OCaml
Stars
24
Forks
7
Avg merge
1d 15h
Merged PRs (30d)
5

Description

at first glance it's not obvious why a melange project can't just use the usual ppx_deriving_yojson/ppx_yojson_conv. And then why melange-json exposes 2 different ppx depending on the compilation target.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation for ppx_deriving_yojson, ppx_yojson_conv, and the two melange-json PPX variants. Explain why Melange and native compilation require different PPX choices and why a single usual PPX cannot serve both targets. The issue names no documentation file or test, so locate the relevant documentation entry point first.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.