ocaml / ocaml/odoc

Review Notes for `odoc` Website

Open
#772 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement stale
Dominant language
OCaml
Stars
355
Forks
114
Avg merge
6d 21h
Merged PRs (30d)
10

Description

What is odoc?

  1. odoc is a documentation generator for OCaml
    Would it be helpful to compare it to Doxygen for concept?

  2. It reads doc comments from your source files and your .mld files, and outputs HTML, LaTeX and man pages.
    REVISION SUGGESTION: It reads doc comments from source files and .mld files, and then it outputs to HTML, LaTeX, and man pages.
    (^^ do these 'man' pages need capitalization or code format [`man'])?

  3. The pages you are reading now are rendered using odoc.
    REVISION SUGGESTION: 'odoc' generated the pages you're reading now.

  4. These comments are picked up by odoc and turned into html, or TeX or manpages.
    REVISIONS SUGGESTION: These comments are picked up by odoc and turned into HTML, TeX, or manpages.
    "manpages" here is written as one word, whereas it's written as two in # 2 above. Which is correct?

  5. The syntax reference is a refinement of that explained in the OCaml manual. The differences are described here.
    Perhaps it would be beneficial to have a taste of that refinement and differences, an example maybe?
    I'm especially confused by "refinement of that explained..." -- refinement of what? the syntax?
    Why should they visit those sites? What will they get from it? Will they know where to look for that information?
    What's important about this syntax refinement?
    Perhaps it would be beneficial to have a little more context here.
    If you choose to do these things or not, I will go back over it to address the passive voice, where possible.

Overall, I'd like to go through it to add the Oxford Comma, as it's part of our group's style guide for consistency. Plus, there are other line editing things to take as well once we get past developmental editing.

(I'll put in a new comment with the odoc for the Authors page and subsequent pages)

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

No file, test, or entry point is named; begin by locating the odoc website pages containing the quoted introductory and syntax-reference text. Resolve the terminology, capitalization, Oxford-comma, and context questions in the issue, then update the relevant pages and review the Authors and subsequent pages as proposed.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.