facebookresearch/fmmax

Documentation

Open

#35 opened on Aug 30, 2023

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees)Jupyter Notebook (15 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (149 stars)
PR merge metrics
 (PR metrics pending)

Description

Would be good to export the API docstrings into some documentation. The examples could be exported too (even better would be to export notebooks with the accompanying text explaining things).

Contributor guide

Research direction
Use a documentation generator like Sphinx to automatically generate API documentation from docstrings, and include Jupyter notebooks as examples. Ensure the output is user friendly and covers key functionalities.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80