ocaml/dune

Simplify/Clarify Web site building

Open

#663 opened on Mar 29, 2018

View on GitHubContributor guide
 (9 comments) (0 reactions) (0 assignees)OCaml (478 forks)github user discovery
good first issuehelp wantedjsoo

Repository metrics

Stars
 (1,882 stars)
PR merge metrics
 (Avg merge 1d 20h) (345 merged PRs in 30d)

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

Research direction
Review the current quickstart section in Dune's documentation, identify unclear parts about js of ocaml executable naming and website assembly, then draft improved explanations or propose a new target for bundling and serving the site.
Tech stack
javascript
Domain
build system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
OCamlDune
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60