NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[DOC] Broken API documentation in 'main' branch

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

Nobody has claimed this yet.

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

Description

Report incorrect documentation

Hi!

The (API documentation) in the main branch only shows the section names, but not the content.

image

Hope it helps!
Miguel

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

Open the linked API documentation and compare the main-branch output with the documentation source or build configuration. Identify why the page shows section names without content, then verify that the generated API page renders its content correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.