Recode-Hive / Stackoverflow-Analysis

Stack overflow is a professional community for developers. This repo analysis 3 years of developer Survey done by Stackoverflow and do visualization and predict the salary of Data Scientist in future.
https://stackoverflow-analysis.streamlit.app/
MIT License
110 stars 102 forks source link

[Documentation Update]: Add a Table of Contents. #278

Closed GUNJESH843 closed 2 weeks ago

GUNJESH843 commented 3 weeks ago

Is there an existing issue for this?

Issue Description

Add a Table of Contents to the Stackoverflow Analysis Guidelines to enhance navigation and improve the overall user experience.

The current documentation is comprehensive but can be challenging to navigate due to its length. A Table of Contents will help users quickly find the sections they are interested in.

Suggested Change

Insert a Table of Contents at the beginning of the documentation, right after the initial badges, and before the "Demo Video" section. The Table of Contents should link to the following sections:

Demo Video Prerequisites Installation Steps Development Finding Insights from Stack Overflow Developer Survey Project Goals Data Source and Background Data Format Expected Work Contributing License Thanks to all Contributors Support

Rationale

A Table of Contents is beneficial as it allows users to quickly navigate to the specific sections they need, improving the usability and accessibility of the documentation. This is particularly important for new contributors who may be looking for specific information on how to get started or understand the project's goals.

Urgency

High

Record

github-actions[bot] commented 3 weeks ago

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible.

GUNJESH843 commented 3 weeks ago

@sanjay-kv can you assign this issue to me?

sanjay-kv commented 3 weeks ago

Fix the badges has well. This might involve lot of iterations.

github-actions[bot] commented 2 weeks ago

Hello @GUNJESH843! Your issue #278 has been closed. Thank you for your contribution!