facebookresearch / facebookresearch/detectron2

broken link in builtin_datasets documentation

Open
#4,228 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
34.7k
Forks
7.9k
PR merge metrics
No merged PRs in 30d

Description

## 📚 Documentation Issue
Hey guys, I've been studying docs and noticed some links can be fixed.

https://detectron2.readthedocs.io/en/latest/tutorials/builtin_datasets.html has a broken link to
https://github.com/facebookresearch/detectron2/blob/main/MODEL_ZOO.md

* How should the above documentation/comment/tutorial improve:
Move datasets/README.md to docs/tutorials/builtin_datasets.md and fix a link to MODEL_ZOO.md.
Additionally, in https://detectron2.readthedocs.io/en/latest/tutorials/getting_started.html
change a link from [datasets/README.md](https://github.com/facebookresearch/detectron2/blob/main/datasets/README.md) to https://detectron2.readthedocs.io/en/latest/tutorials/builtin_datasets.html

Contributor guide

Open the contributing guide

Research direction

Start with datasets/README.md and the existing docs/tutorials/builtin_datasets.md, then inspect the MODEL_ZOO.md link and the dataset link in the getting_started documentation. Done means the dataset documentation is in the requested location, its MODEL_ZOO.md link works, and getting_started points to the rendered builtin_datasets page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.