voxel51/fiftyone

[FR] Move documentation notebooks to the fiftyone-examples repository

Open

#756 opened on Jan 8, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (4,021 stars) (400 forks)batch import
documentationenhancementgood first issue

Description

Proposal Summary

Documentation notebooks should be kept in the fiftyone-examples repository to reduce the size of the main repository. The documentation build process would have to be updated.

Motivation

Maintain a reasonable repository size.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonDocumentation build tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes moving documentation notebooks from the main fiftyone repository to the fiftyone examples repository. To implement this, first understand the current documentation build process in the main repo, likely involving Sphinx or similar tools. Then identify which notebooks need to be moved and update the build configuration to point to the external repository. The fiftyone examples repo already exists and should be examined for structure. Comments in the issue may provide additional context.
[FR] Move documentation notebooks to the fiftyone-examples repository · voxel51/fiftyone#756 | Good First Issue