ocaml / ocaml/dune

Simplify/Clarify Web site building

Open
#663 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted jsoo
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 17m
Merged PRs (30d)
287

Description

I think this use case deserves to be better explained, maybe in the "quickstart" section. Currently there are many things that are not very clear:

  • An executable with (js_of_ocaml (..)) and a public name will build/install the .exe, not the .js. This is not intuitive.
  • If I have an HTML file that uses the generated js, it's not clear how to put the website together in order to visit it without either pointing inside _build or moving the files around.
  • What's the right way to handle static data and/or bundle additional js files?

I feel like the basic supports is there (and I ended up successfully building my .bc.js) but it feel fairly unfinished. I'm not sure what the idiomatic dune way is, but a little bit of polish would be sufficient to make the situation much better. Maybe with a new target that would put the files together and launch the website, or something like that ?

Contributor guide

Open the contributing guide

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 with the quickstart section and the existing js_of_ocaml build guidance; no specific files or tests are named in the issue. Reproduce the documented website-building flow, including generated JavaScript, HTML, static data, and additional JavaScript, then define the documentation or target behavior needed for a complete, clear workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, ocaml
Domain
build-system, web-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.