Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DISC-18903] Remove jquery and hanging javascript assets. #22014

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Math-ias
Copy link
Contributor

Some notes on files I changed.

  • scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala This adds jquery to list of resources to load in a scaladoc page. I could remove it after fixing ux.js.

    If you search for jquery now it appears in dagre-d3.min.js. But this is only in doc comment examples.

  • scaladoc/resources/dotty_res/scripts/ux.js jQuery powered things like sidebar link behaviour (issuing GET) and item expansion (from mini blurb to full description).

  • docs/_spec/public/scripts/toc.js I tried to do a 1 to 1 port, included bugs like scroll listener being unhooked after clicking a link in the TOC. This table of contents ISN'T the same as what appears in normal docs. This is specific to the language spec. There might be an opportunity here to share code, see IntersectionObserver in ux.js.

  • docs/_spec/public/scripts/main.js Nothing exciting here.

  • docs/_spec/_layouts/toc.yml Loads jQuery for previously mentioned language spec TOC.

  • docs/_spec/_layouts/default.yml I think duplicate to above.

  • docs/_assets/js/toolbar.js Lots of unused jquery code. This is hanging source code, with references to code that was removed with commit ... 0f78f739dd31ba095f19d32707315d94469ae9f9

  • docs/_assets/css/toolbar.css Same as above.

  • docs/_assets/js/sidebar.js togglePath call path removed in same commit above.

Closes #18903 .

Some notes on files I changed.
 * `scaladoc/src/dotty/tools/scaladoc/renderers/Resources.scala`
   This adds jquery to list of resources to load in a scaladoc page.
   I could remove it after fixing `ux.js`.

   If you search for jquery now it appears in `dagre-d3.min.js`.
   But this is only in doc comment examples.

 * `scaladoc/resources/dotty_res/scripts/ux.js`
   jQuery powered things like sidebar link behaviour (issuing GET)
   and item expansion (from mini blurb to full description).

 * `docs/_spec/public/scripts/toc.js`
   I tried to do a 1 to 1 port,
   included bugs like scroll listener being unhooked
   after clicking a link in the TOC.
   This table of contents ISN'T the same as
   what appears in normal docs.
   This is specific to the language spec.
   There might be an opportunity here to share code,
   see IntersectionObserver in `ux.js`.

 * `docs/_spec/public/scripts/main.js`
   Nothing exciting here.

 * `docs/_spec/_layouts/toc.yml`
   Loads jQuery for previously mentioned language spec TOC.

 * `docs/_spec/_layouts/default.yml`
   I think duplicate to above.

 * `docs/_assets/js/toolbar.js`
   Lots of unused jquery code.
   This is hanging source code,
   with references to code that was removed with commit ...
   ```
   0f78f73
   ```
 * `docs/_assets/css/toolbar.css`
   Same as above.

 * `docs/_assets/js/sidebar.js`
   `togglePath` call path removed in same commit above.
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