Cloud-CV / Cloud-CV/EvalAI

Improve documentation structure

Open
#2,578 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2k
Forks
984
Avg merge
2h 54m
Merged PRs (30d)
14

Description

#### The current picture:
The structure for the readthedocs documentation for EvalAI (https://evalai.readthedocs.io/en/latest/) is a bit hard to follow, The titles of different section as seen in the panel on the left look like random topics where two unrelated or two similarly titled topics are placed next to each other.

#### The improvement:
As the documentation covers a wide variety of topics, we should organize the topics into further sections with friendly names such as: **What is EvalAI?**, **How do I use it?** and **How to contribute?**. This is just one way, we can be more creative here.

For a visual idea of the sections, here is a snip from [Scrapy's documentation](https://scrapy.readthedocs.io/en/latest/), the sections and topics are excellently titled, and finding the required information is really easy:
![scrapy-rtd-left-panel](https://user-images.githubusercontent.com/37668193/71767273-871d4700-2f30-11ea-836d-039027248095.PNG)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current EvalAI ReadTheDocs structure and the left navigation, then compare it with the linked Scrapy example. Group the existing topics under clear sections such as project overview, usage, and contribution; the work is done when related topics are easier to find in the navigation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.