ocaml / ocaml/dune

Provide instructions on getting emacs dune-mode installed

Open
#2,184 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs question
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

I ended up having to manually load the file from the install location in my ~/.opam directory. There is probably a better way to get the package available, but I couldn't find any trace of it.

If someone notes the preferred installation method, I'm happy to test it and write up the documentation.

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 by checking the existing Dune and emacs dune-mode documentation, then verify how the installed dune-mode file is exposed from the user's ~/.opam directory. Done means documenting the preferred installation and loading method clearly enough for users to follow it without manually locating the file.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, ocaml
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.