Skip to content

docs(README): update community helper section with details about mhrv…#1146

Open
ardalan-ab wants to merge 3 commits into
therealaleph:mainfrom
ardalan-ab:communityHelper/Readme
Open

docs(README): update community helper section with details about mhrv…#1146
ardalan-ab wants to merge 3 commits into
therealaleph:mainfrom
ardalan-ab:communityHelper/Readme

Conversation

@ardalan-ab
Copy link
Copy Markdown

Description

This PR adds a small "Community Helpers" section to the README linking to the external extension repository:

The extension is now maintained separately to keep the main repository focused on the proxy + Apps Script core while still making the helper tool discoverable for users.

Since the previous review, the extension repository also includes:

  • a CI sync check to ensure chrome-extension/Code.gs stays synchronized with assets/apps_script/Code.gs
  • additional basic test coverage improvements
  • a version-check mechanism for extension updates

I’m also open to the extension being published under your account for consistency and user trust, while still continuing maintenance and contribution on my side.

This follows the direction discussed in the earlier PR review.


ترجمه فارسی

این PR یک بخش کوچک با عنوان "Community Helpers" به README اضافه می‌کند که به ریپازیتوری جداگانه افزونه لینک می‌دهد:

افزونه اکنون به‌صورت جداگانه نگهداری می‌شود تا ریپازیتوری اصلی روی هسته پروژه (proxy و Apps Script) متمرکز باقی بماند و در عین حال این ابزار کمکی همچنان برای کاربران قابل دسترس باشد.

همچنین بعد از ریویوی قبلی، موارد زیر به ریپازیتوری افزونه اضافه شده‌اند:

  • CI sync check برای اطمینان از همگام بودن chrome-extension/Code.gs و assets/apps_script/Code.gs
  • بهبود پوشش تست‌های اولیه
  • قابلیت بررسی نسخه برای اطلاع از جدیدترین نسخه افزونه

همچنین من مشکلی ندارم که افزونه برای هماهنگی بیشتر و اعتماد کاربران تحت اکانت شما منتشر شود، در حالی که همچنان نگهداری و توسعه آن را ادامه می‌دهم.

این PR بر اساس مسیر پیشنهادی در ریویوی قبلی ایجاد شده است.

@github-actions github-actions Bot added the type: docs docs: PR — auto-applied by release-drafter label May 13, 2026
@dazzling-no-more
Copy link
Copy Markdown
Contributor

Please make sure the Persian text starts with Persian alphabet, otherwise the right to left is not respected. Maybe rephrase some of the sentences.

@ardalan-ab
Copy link
Copy Markdown
Author

ardalan-ab commented May 13, 2026

Please make sure the Persian text starts with Persian alphabet, otherwise the right to left is not respected. Maybe rephrase some of the sentences.

Thank you for the review. I made the necessary changes. Could you please take another look? Let me know if there's anything else that needs to be adjusted

Copy link
Copy Markdown
Owner

@therealaleph therealaleph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for moving the helper-extension direction toward an external repo instead of vendoring the whole extension here.

I would like one cleanup before merging this README change: please avoid listing the same helper twice in the first screen plus a full section below. The current diff adds:

  • a top-of-README bold one-liner in English,
  • a full English Community helpers section,
  • a top-of-Persian bold one-liner,
  • a full Persian ابزارهای جامعه section.

That is a lot of visual weight for an optional third-party helper, and it can read like an official dependency. I think the better shape is:

  • one Community helpers / ابزارهای جامعه section only,
  • include a clear note that it is optional and third-party maintained,
  • link README + usage docs from there,
  • no top banner above the quick start.

Once the duplication is trimmed, this is mergeable as a docs-only discoverability improvement.


[reply via Anthropic Claude | reviewed by @therealaleph]

@ardalan-ab
Copy link
Copy Markdown
Author

removed duplicate helper-extension references from the top sections and consolidated them into a single Community helpers / ابزارهای جامعه section. The wording was also adjusted to clearly mark it as optional and third-party maintained.

One quick question for clarification (as discussed earlier): would you prefer the helper extension to be published to the Chrome Web Store at some point, or should it remain as a GitHub-distributed tool only?
Also, I don’t have a Chrome Web Store developer account—if you ever decide to publish it, I’m fine if it’s done under your account/name.

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

Labels

type: docs docs: PR — auto-applied by release-drafter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants