Cloud-CV / Cloud-CV/EvalAI

🧭 Fix Left-Hand Navigation Bar in EvalAI Docs

Open
#4,692 4 comments 0 reactions 1 assignee Claimed by @aditi-dsi View on GitHub
Dominant language
Python
Stars
2k
Forks
984
Avg merge
2h 54m
Merged PRs (30d)
14

Description

**Description:**

The left-hand sidebar in the EvalAI documentation appears cluttered and unorganized. This affects usability and makes it harder for users to locate relevant sections quickly.

📸 **Screenshot for reference:**

![Sidebar Screenshot](https://github.com/user-attachments/assets/7bb2f17c-7ada-4eb1-bb7c-442b45094c0e)

### 🛠 Issues Identified:

* No clear grouping or hierarchy between related topics (e.g., challenge hosting vs participation vs development).
* Inconsistent naming conventions (e.g., some start with verbs, others are nouns).
* Redundant or scattered structure (e.g., "Submission" vs. "Make Submission Public/Private").
* Lack of collapsible sections for improved readability.

### ✅ Suggested Fix:

Refactor the sidebar navigation in the docs site with the following improvements:

* Group content under logical categories like:

* 🧪 Getting Started (Introduction, Installation)
* 🎯 Hosting a Challenge (Host Challenge, Challenge Configuration, Writing Evaluation Script, Approve Challenge)
* 🚀 Participating in Challenges (Participate, Make Submission Public/Private)
* ⚙️ Developer Guide (Pull Request, Contributing Guidelines, Directory Structure, Migrations, Architecture)
* 📚 Reference (Cite, FAQ, Glossary)

* Ensure consistent naming (e.g., use "Submit a Challenge", "Join a Challenge", etc.).

* Use collapsible/expandable headings (if the documentation theme supports it).

### 📍References:

* \[Current Docs Sidebar Screenshot attached above]

### 💡 Benefit:

Improving the navigation structure will significantly enhance documentation usability for new users, challenge hosts, and contributors.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.