search

ocaml / ocaml.org

The official OCaml website.
https://ocaml.org
Other
161 stars 326 forks source link

Guidelines for naming files and characters allowed in file names #1635

Open psb opened 1 year ago

psb commented 1 year ago

Is there a guide for naming files which also lists the characters allowed in file names? I tried searching for one but all the guides I've found do not mention anything about the characters allowed in file or folder names.

I have been developing some frontend applications using React frameworks and Reason, and the frameworks often use special characters in the folder names for capturing parameters, e.g., a URL of https://github.com/ocaml/ocaml.org/issues/1 might have a folder path of ./src/app/issues/[issue_id]/code_for_page.re; some other frameworks might use file name based routing like ./src/app/routes/issues.$issue_id.tsx. Through trial and error I have been finding out what characters work and don't work, but often Dune does not give any (clear) errors, although the LSP might complain.

It would be very useful to have a list of characters that are allowed in folder names and file names.

Raven49 commented 1 year ago

I have set up ocaml.org and i have also solved https://github.com/ocaml/ocaml.org/pull/1658 issue which has been approved.As a further contribution towards outreachy , can I work on this issue ? @sabine @SaySayo