Skip to content

Comments

Feat: Added and Automated INDEX.md to Dynamically Track All Projects !!#76

Merged
devmalik7 merged 2 commits intodevmalik7:mainfrom
Jivi-this-side:feat-index-auto-update
Oct 13, 2025
Merged

Feat: Added and Automated INDEX.md to Dynamically Track All Projects !!#76
devmalik7 merged 2 commits intodevmalik7:mainfrom
Jivi-this-side:feat-index-auto-update

Conversation

@Jivi-this-side
Copy link
Contributor

@Jivi-this-side Jivi-this-side commented Oct 12, 2025

Created centralized INDEX.md file at the root of the repository that automatically lists all project folders (mini-projects) organized by language, along with their respective authors.

Closes #63 !!

It also includes a Python automation script (update_index.py) and a GitHub Action workflow to keep the index up to date whenever new contributions are added.

Features Added

✅ Added INDEX.md that lists all projects in a clean, tabular format:

🐍 Python

Project Author
number_guess_game @pqr
qr_code_generator @abcd
  • Implemented update_index.py

  • Scans all language folders

  • Detects project names

  • Fetches the latest author (commit contributor) automatically

  • Updates INDEX.md with the latest structure

⚙️ Added GitHub Action ( .github/workflows/update-index.yml )

  • Runs automatically on push or PR merge

  • Updates and commits the new index if changes are found

How It Works

  • When new projects are added or modified:

  • Run python update_index.py locally or

  • Let the GitHub Action handle it automatically on push/merge.

  • The script regenerates INDEX.md and commits changes if necessary.

Thank you! 🌻

@Jivi-this-side
Copy link
Contributor Author

Hello @devmalik7 Sir !
I’ve just raised the PR for this issue. Kindly take a look when you have time and let me know if any further improvements or changes are required.
Thank you! 😊

@Jivi-this-side Jivi-this-side changed the title Feat: Add & Automate INDEX.md to Track All Projects Feat: Created INDEX.md with Author Attribution and Auto-Update Support (Python) Oct 13, 2025
@Jivi-this-side Jivi-this-side changed the title Feat: Created INDEX.md with Author Attribution and Auto-Update Support (Python) Feat: Added and Automated INDEX.md to Dynamically Track All Projects !! Oct 13, 2025
@devmalik7 devmalik7 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted hacktoberfest python Automation labels Oct 13, 2025
@devmalik7
Copy link
Owner

@Jivi-this-side Thank you for the contribution, merging it now.

@devmalik7 devmalik7 merged commit 5a7bbd6 into devmalik7:main Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Automation documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest hacktoberfest-accepted python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🗂️ Add & Automate INDEX.md to Track All Projects

2 participants