Refactor README formatting and content

[Dippp10-ally]

Updated README to improve formatting and content structure.

Summary [required]

Related Issue [required]

Closes #105

Type of Change [required]

• Bug fix — resolves a broken behaviour
• Feature — adds new functionality
• Data — adds new projects to data/projects.json
• Documentation — updates docs, README, or code comments only
• Style — CSS or visual changes only, no logic change
• Refactor — restructures code without changing behaviour
• Test — adds or updates tests

What Was Changed [required]

File	Change made
Added clear_cache() function
Added test for cache invalidation

How to Test This PR [required]

1. Clone this branch: git checkout your-branch-name
2. Install dependencies: pip install -r requirements.txt
3. Run the app: python app.py
4. Open http://127.0.0.1:5000 and...
5. Run the tests: python tests/test_basic.py

Expected test output:

27 passed, 0 failed out of 27 tests

Test Results [required]

paste output here

Screenshots (if UI change)

Before	After
screenshot	screenshot

Self-Review Checklist [required]

• I have read CONTRIBUTING.md and followed all guidelines
• My branch name follows the convention: feat/, fix/, docs/, data/, style/, test/
• I have run python tests/test_basic.py and all 27 tests pass
• I have run flake8 . locally and there are no errors
• I have not introduced any print() or console.log() debug statements
• Every new function I wrote has a docstring
• I have not modified files outside the scope of the linked issue
• If I changed the UI, I tested it at 375px (mobile) and 1280px (desktop)
• If I added a project to the dataset, it has all required JSON fields

Notes for Reviewer

[vercel]

@Dippp10-ally is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

Thank you for submitting your first pull request to DevPath.

Before review:

• Complete the PR template fully
• Ensure all tests pass
• Link your PR to an issue
• Keep changes scoped to the issue

A maintainer will review your contribution soon.

[Dippp10-ally]

@komalharshita ji , do merge my above pull request 164 that closes issue number 105...do assign gssoc:approved and level:intermediate labels to issue number 105 and pull request number 164

[komalharshita]

Thank you for the effort put into this PR. The README improvements show good initiative and a strong attempt to improve project presentation and contributor onboarding.

However, this PR cannot be merged in its current state because there are several major issues that need to be addressed first:

1. The linked issue appears incorrect and does not match the scope of the changes made. (include issue without space eg. Closes #issue_number)

   • Please link the correct issue related to the README/documentation refactor.

2. The PR template contains unrelated information:

   • utils/recommender.py
   • tests/test_basic.py
     These files were not modified in this PR.

3. The PR introduces placeholder/broken content:

   • https://your-demo-link.com
   • docs/images/devpath-preview.png (image asset not included)

4. Several technical claims were added without verification:

   • “Startup time under 1 second”
   • “O(n) recommendation scoring”
     Please avoid adding unverified engineering claims.

5. Important existing documentation sections were removed or heavily reduced:

   • route documentation
   • contributor workflow details
   • onboarding guidance
   • dataset extension details

6. Some markdown formatting appears malformed and may break README rendering.

Because this PR significantly restructures the entire README, it needs to be more carefully scoped and aligned with the existing project documentation standards.

Please revise the PR accordingly and resubmit the changes in a more focused and validated form.

[Dippp10-ally]

@komalharshita ji , I have modified the link to issue , ,such as wording closes#105 are now together.....

Thank you for the detailed review and constructive feedback.

I understand the concerns raised regarding the scope, documentation accuracy, and formatting consistency of the README refactor. I’ll revise the PR accordingly before resubmitting.

Planned fixes include:

• Linking the correct issue in the PR description using the proper format (Closes #issue_number)

• Removing unrelated references from the PR template (utils/recommender.py, tests/test_basic.py)

• Eliminating placeholder/demo content and adding only verified assets/resources

• Removing unverified performance/engineering claims unless properly benchmarked

• Restoring and improving the previously existing documentation sections:

  • route documentation
  • contributor workflow
  • onboarding guidance
  • dataset extension details

• Fixing malformed markdown and validating README rendering consistency

I’ll also reduce the scope of the PR to keep the changes more focused and aligned with the project’s documentation standards.

Thank you again for the review and guidance.