Skip to content

docs: sync README and CHANGELOG with Hindi Tafseer support additions#13

Open
Copilot wants to merge 2 commits into
cairofrom
copilot/sync-documentation-with-codebase-again
Open

docs: sync README and CHANGELOG with Hindi Tafseer support additions#13
Copilot wants to merge 2 commits into
cairofrom
copilot/sync-documentation-with-codebase-again

Conversation

Copilot AI commented Feb 22, 2026

Copy link
Copy Markdown
Contributor

Documentation was not updated when copilot/add-hindi-tafseer-support landed, leaving four new data files, four new output files, a GitHub Actions workflow, and updated script capabilities entirely undocumented.

README.md

  • Tech Stack: added GitHub Actions row
  • Repository Structure: added en.yusufali.txt, translit_en.txt, hindi-mokhtasar.json.zip, abridged-explanation-of-the-quran.json.zip with format annotations
  • Translations Included: added second table for the four plain-text-only outputs (quran_english_yusufali.txt, quran_translit_unicode.txt, quran_hindi_mokhtasar.txt, quran_english_abridged.txt)
  • Usage step 3: replaced prose list of 6 files with a complete table of all 10 generated outputs
  • Data Sources: added Yusuf Ali, Quran Unicode Project, Al-Mokhtasar JSON, and Abridged Explanation JSON entries

CHANGELOG.md

Added [Unreleased] — 2026-02-22 entry covering:

  • New data files and corresponding output files
  • docs.zip archive
  • .github/workflows/scrape.yml — Alafasy audio upload to Hugging Face Hub
  • gentxtforquran.py — three new input format handlers (pipe-delimited, sequential transliteration, JSON ZIP)
  • gendocshtml.py — updated to render all new translations in HTML pages

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…additions)

Co-authored-by: druvx13 <131332414+druvx13@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to reflect current project state docs: sync README and CHANGELOG with Hindi Tafseer support additions Feb 22, 2026
Copilot AI requested a review from druvx13 February 22, 2026 03:51
@druvx13 druvx13 marked this pull request as ready for review February 22, 2026 04:05
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.

2 participants