Skip to content

Update README and templates - #1778

Merged
IaroslavKhvorostenko merged 2 commits into
AdguardTeam:masterfrom
dotext:patch-1
Oct 9, 2026
Merged

IaroslavKhvorostenko merged 2 commits into
AdguardTeam:masterfrom
dotext:patch-1

Conversation

@dotext

@dotext dotext commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Changes

README.md

  • Rearrange layout to match other recent AG repos for consistency
  • Update Twitter to X
  • Remove visual bug with <a href showing space and underline after SVG image
  • Update reporting tool link to match same as config.yml (https://link.adtidy.org/forward.html?action=report&app=home&from=github)
  • Remove outdated "Our plans" link and section
  • Update translation KB article link
  • Minor revisions (typos, grammar, etc.) made

01-bug-report.yaml

  • Include AdGuard Mail Tracking Protection filter
  • Minor version numbering updates to keep it in line with recent releases
  • Update reporting tool link to match same as config.yml (https://link.adtidy.org/forward.html?action=report&app=home&from=github)
  • Update filter lists to match what is currently available (including language-specific)
  • DNS description and selection now clearer
  • Minor revisions (typos, grammar, etc.) made
  • Capitalisation fixes for all AG repo cohesion
  • General cleanup and improvements with spacing, including quality-of-life improvements when completing pre-filled text

02-feature-request.yaml

  • Added missing "Thanks" message at beginning
  • Capitalisation fixes for all AG repo cohesion
  • General cleanup and improvements with spacing

03-question.yaml

  • Add required answer for using the latest version
  • Add checkbox for checking the knowledge base to match other versions

config.yml

  • Update knowledgebase to "AdGuard Knowledge Base"

Context

I've noticed that the README.md files are not unified in layout, need updated links and to resolve a few visual issues. The GitHub templates for Issues were also with outdated filter lists and with minor opportunities for some tweaks to bring it up to date with recent releases and fix a few things here and there.

Since working with others on the other PRs for updating the README.md and template files, there are a few more things that should be applied to the templates for the sake of cohesion. These changes have already been applied to this existing PR, but PRs for this second revision have been made if already merged before these changes:

Also added further repos that could use the same update treatment:

@IaroslavKhvorostenko IaroslavKhvorostenko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the cleanup — the README fixes (broken <a></a>, Website URL, X/Twitter, reporting-tool link) and the template updates look good, and I checked the filter changes against the current app catalog.

A few optional nits (your call):

  • DNS Protocol: the description says "Skip this if DNS protection is disabled", but the field is now required: true. Maybe reword to "If you don't use DNS protection, select 'DNS protection disabled'".
  • Placeholders use macOS Golden Gate 27.2 / Safari 27.2 — 27.2 is a beta; the public release is 27.0. Consider using a released version as the example.
  • README screenshots are still from v2.12 while the app is on 2.19/2.20 — might be worth refreshing while you're here.
  • alt="Beta version>" has a stray >.
  • Not a blocker: for this repo app=mac would give better attribution (utm_source=mac) than app=home, but matching config.yml is fine.

For the record, I verified the rest against the app: removing Block Java is correct (the setting was removed in v2.20, #1705), and the filter-list changes match the current catalog — Mail Tracking Protection (25), Web Annoyances Ultralist (201) and Dandelion Sprout's Anti-Malware List (259) are present, and NoCoin is gone.

Thanks again!

Comment thread .github/ISSUE_TEMPLATE/01-bug-report.yaml Outdated
@dotext
dotext marked this pull request as draft October 7, 2026 16:30
@dotext
dotext marked this pull request as ready for review October 7, 2026 17:12
@dotext

dotext commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor Author

Thanks for your help with this @IaroslavKhvorostenko!

  • Wording for DNS has been updated.
  • Version example for macOS and Safari have been changed to 27.0.1 (Rationale at the time was to help keep this template a little more fresh by the time 27.2 is soon to be released, but you're right).
  • Stray > has been removed.
  • Typo in Stevo's has been fixed.
  • The language-specific list has also been updated.

I'll need some additional help with the following:

  • README screenshots are still from v2.12 while the app is on 2.19/2.20 — might be worth refreshing while you're here.

Screenshots are currently sourced from https://cdn.adguard.com/content/release_notes/ad_blocker/mac/v2.12/*. I'm happy to update these, but do not have directory viewing or upload access to the CDN and I'd need to upload directly to this repo instead. Otherwise, happy to have someone with access provide me the updated src links or suggest the change accordingly.

  • Not a blocker: for this repo app=mac would give better attribution (utm_source=mac) than app=home, but matching config.yml is fine.

I did use the exact URL sourced to match all repos, but I'm happy to resolve this across the board. I just don't know what I'd put for all the other products, and where I can get this list from. Otherwise, this would be the only repo with a different URL.

dotext and others added 2 commits October 8, 2026 09:49
Fixes typo of what should be Stevo's AI Blocklist

Co-authored-by: Iaroslav Khvorostenko <i.khvorostenko@adguard.com>

@IaroslavKhvorostenko IaroslavKhvorostenko left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the quick turnaround — I re-checked the updated files against the current app catalog, including the localized filter names the app actually displays, and everything checks out:

  • Steveo's → Stevo's — fixed ✓
  • DNS wording (DNS Server description + DNS Protocol) — fixed ✓
  • macOS Golden Gate 27.0.1 / Safari 27.0.1 — good, thanks
  • alt="Beta version" — fixed ✓
  • The language-specific list is now fully aligned with the catalog (56 items) — nice

On your questions:

  • Screenshots: no need for CDN access — leaving the v2.12 images as-is is fine for this PR; a maintainer can refresh them separately once new assets are available.

Thanks again!

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