adjs.dev doc site fails to load when an ad blocker is used
joelcolucci opened this issue · comments
Description
Currently the adjs docs website is client-side rendered. Pieces of the page are loaded via XHR/Ajax.
The website fails to load when a user has an ad blocker on. Our current hypothesis is this occurs because the ad blocker see’s “ad” in the URL and blocks the requests assuming it’s ad tracking.
To reproduce:
flip ad blocker switch and reload
Root cause:
AdBlock uses 'filters' to block ajax requests. Some of these filters are defined here https://easylist.to/
As we see /adjs/*pattern can be found in the primary filter ("easy list"): https://easylist.to/easylist/easylist.txt
Proposed solution - migrate from Docsify to Docusaurus
Refs:
https://www.npmjs.com/package/docusaurus
https://www.npmjs.com/package/docusaurus-init
Why Docusaurus?
Docsify’s SSR documentation is sketchy, no demos or showcase SSR examples
Docusaurs is SSR - confirmed
Newer stable product, well documented, react, typescript, webpack...
What’s done
- Explored showcase websites, no XHR requests https://v2.docusaurus.io/showcase
- Ran locally as a separate react app, used https://www.npmjs.com/package/docusaurus-init
- Confirmed that it creates documentation website from .md files (much like docsify)
- Confirmed that there are no XHR requests and page source has content
- Easy to use
Effort to migrate
- Integrate with existing codebase - need help
- Configure sidebar, remove unnecessary navigation, links and pages (unused navs is also issue in the the existing documentation, probably leftovers from demo site)
- Decorate .md documents with ids and titles
New findings:
- Adblocker filters out not just ajax calls, but also all content downloads from a adjs domains. (Confirmed by redirecting localhost to adjs in etc/hosts)
- Migration to a different document processor will not solve the issue.
- New proposed solution is to serve docs from CDN