jaredly / jaredly/redoc

Relationship to Odoc and Ocamldoc?

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
114
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Hi! What's the relationship of this project to Odoc and Ocamldoc? Perhaps it could be explained somewhere to answer the question "why does this project exist separately"?

Contributor guide

No contributing guide indexed for this repository

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

Review the existing project documentation and compare its stated purpose with Odoc and Ocamldoc. Add a clear explanation of the relationship and why redoc exists separately, then verify that a reader can find and understand the distinction.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.