Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feat]: Updating and Redoing the README.md file #209

Closed
5 tasks done
Titus210 opened this issue Oct 8, 2024 · 0 comments
Closed
5 tasks done

[Feat]: Updating and Redoing the README.md file #209

Titus210 opened this issue Oct 8, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Titus210
Copy link
Contributor

Titus210 commented Oct 8, 2024

Description

Issue Overview:

The current README.md file needs to be updated to provide a comprehensive project list that includes all existing projects with direct links. This issue aims to ensure that each listed project redirects to the correct section or repository, providing clear navigation for users and contributors.

Proposed Solution:

The following improvements will be made to the README.md file:

  1. Project List:

    • Compile a list of all projects within the repository.
    • Ensure that each project is listed in a structured format with the project title, brief description, and a link to its corresponding folder or external site.
    • Add any missing projects to the list, ensuring consistency in descriptions and formatting.
  2. Working Links and Navigation:

    • Verify that each project link is functional and redirects to the correct location (e.g., project folders within the repository or external links).
    • Implement anchor links for internal navigation to specific sections of the README.md file, if applicable.
  3. Enhanced Formatting:

    • Use markdown elements such as bullet points, tables, or headers to create a clean, organized look for the project list.
    • Highlight project names using bold text and add icons for better visual appeal (optional).

Tasks:

  1. Review all current projects and identify those missing from the README.md file.
  2. Update the project list with titles, descriptions, and correct links.
  3. Test each link to ensure it redirects to the correct project folder or URL.
  4. Format the list to enhance readability and presentation.

Expected Outcome:

The updated README.md file will provide a clear, organized, and navigable project list that allows users and contributors to easily access each project. All project links will be verified to ensure they work correctly and redirect to the intended location.

@AkshitGarg24 / @beRajeevKumar Please review and approve this issue so we can proceed with updating the documentation. If there are additional requirements or specific project names you’d like to include, let me know. Thank you!

Checklist

  • I have checked the existing issues
  • I have read the Contributing Guidelines
  • I'm a GSSoC'24-Extd contributor
  • I'm a Hacktoberfest'24 contributor
  • I am willing to work on this issue (optional)
@Titus210 Titus210 added the enhancement New feature or request label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants