NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[RMP] Centralize Documentation into the Merlin/Merlin repo

Open
#788 2 comments 1 reaction 5 assignees View on GitHub

@nv-alaiacano is already working on this.

Since Jun 27, 2023.

examples roadmap
Dominant language
Python
Stars
907
Forks
129
PR merge metrics
No merged PRs in 30d

Description

Problem:

The feedback of our repository is that it is easy to follow:

  • Every repository has its own documentations. Users have to switch back and forth between documentations
  • There is no single entry point for users where to start and read something end-to-end

Some examples:

Goal:

Provide a better user experience for our documentations

High Level Decision:

We need to decide:

  • How should (new) users discover Merlin?
  • Do we have one centralized documentation vs. documentations per repository?
      • If centralised - what does it mean? Do we move all API docstring documentation into one repository?

ADR: https://docs.google.com/document/d/1FmK55tAo0wy0tHUe3eE8xqZKGDYSvy0tvq8Y036854A/edit#heading=h.dspp0kxpgck1

Some Options:

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.