Skip to content

Guidelines #1992

Open
Open
@patrick-nicodemus

Description

@patrick-nicodemus

OCaml.org/docs/guidelines contains much that is in need of updating.
Currently the complication advice section links to an old Caml page hosted on the way back machine for examples of Makefiles. A working link is better than a broken link for sure but this seems to be outdated advice, users should be pointed towards dune.

The section on how to use Emacs is weird because it describes specific keyboard shortcuts in Emacs for recompiling and jump to next error and does not mention Merlin or Tuareg. I would think that the whole section on emacs could be removed and replaced with links to Merlin and Tuareg together with a brief overview of their functionality if the GitHub pages for those pages are insufficiently clear.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions