note.md

README Automation Notes

Short Answer

You should not directly edit README.md for permanent changes.

Reason: README.md is regenerated by the automation pipeline and manual edits will be overwritten on the next refresh.

How README Is Built

Refresh pipeline:

1. python .github/readme-automation/generate_readme.py
2. python .github/readme-automation/update_project_directory.py
3. python .github/readme-automation/validate_readme_assets.py

Script entrypoint:

• .github/readme-automation/refresh_readme.ps1

Automated vs Not Automated (Inside README)

Fully Automated Sections

These are generated each refresh and should be edited via source files, not directly in README.md:

1. Hero banner + intro heading/subtitle
2. Purpose & Vision
3. Subject Portfolio Matrix
4. Portfolio Highlights
5. Repository Analytics
6. Course Breakdown (project listing table)
7. Tech Stack & Tools
8. Recent Activity (latest commits)
9. Project Structure
10. Portfolio Author section
11. License & Usage
12. Footer tagline

Auto-updated Block

• Project table between markers:

This block is refreshed from project JSON metadata.

Where To Edit Safely

For Author Part changes

Edit:

• .github/readme-automation/generate_readme.py

Look for section title:

• PORTFOLIO AUTHOR

Update name, links, institution, bio text there.

For project rows in Course Breakdown

Edit:

• .github/readme-automation/data/project_directory.json

Then run refresh.

For wording/design across sections

Edit:

• .github/readme-automation/generate_readme.py

Then run refresh.

Files Generated by Automation

1. README.md
2. .github/profile/README.md

Recommended Workflow

1. Edit source file (generator or project_directory.json)
2. Run .github/readme-automation/refresh_readme.ps1
3. Review README.md
4. Commit and push