NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[Task] Centralize API Documentation in Merlin

Open
#1,053 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

Create API Documentation for all Merlin packages in central Merlin documentation site.

Additional context
Add any other context, code examples, or references to existing implementations about the task here.

Parent: https://github.com/NVIDIA-Merlin/Merlin/issues/788

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 reading the parent issue #788 and identifying the Merlin packages that require API documentation. Review the existing central documentation site and package documentation structure; done means all packages have their API documentation collected there.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.