Skip to content

docs: fix markdown rendering and broken license link#795

Open
Mohit-001-hash wants to merge 1 commit into
param20h:devfrom
Mohit-001-hash:docs-fix-readme-rendering
Open

docs: fix markdown rendering and broken license link#795
Mohit-001-hash wants to merge 1 commit into
param20h:devfrom
Mohit-001-hash:docs-fix-readme-rendering

Conversation

@Mohit-001-hash

Copy link
Copy Markdown

📋 PR Checklist

Thank you for contributing to PDF-Assistant-RAG! 🎉
Please fill out this template before submitting. PRs without it filled in will be closed.


🔗 Related Issue

Closes #None


📝 What does this PR do?

This PR fixes a markdown rendering issue and a broken link in the README:

  • Added a missing blank line before the ## 🌟 GirlScript Summer of Code 2026 heading so it renders correctly as a header.
  • Fixed a case-sensitive dead link in the License section at the bottom of the file (changed (license) to (LICENSE)).

🗂️ Type of Change

  • 🐛 Bug fix
  • ✨ New feature
  • 🔧 Refactor / code cleanup
  • 📝 Documentation update
  • 🎨 UI / styling change
  • ⚙️ CI / tooling / config change
  • 🧪 Tests

🧪 How was this tested?

Verified the markdown preview locally to ensure the heading renders correctly and the license link resolves accurately.

  • Ran the backend locally (uvicorn app.main:app --reload)
  • Ran the frontend locally (npm run dev inside frontend/)
  • Tested the affected API endpoints manually
  • Added / updated tests

📸 Screenshots (if UI change)

N/A


⚠️ Anything to flag for reviewers?

None.


✅ Self-Review Checklist

  • My branch is based on dev, not main
  • I have not added any secrets / API keys
  • I have not modified main branch or any HuggingFace deployment config
  • My code follows the existing style (no unnecessary formatting changes)
  • I have updated relevant docs / comments if needed

@Mohit-001-hash Mohit-001-hash requested a review from param20h as a code owner July 6, 2026 13:24
@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

@Mohit-001-hash is attempting to deploy a commit to the param20h's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant