Skip to content

Latest commit

 

History

History
252 lines (169 loc) · 6.52 KB

CHANGELOG.rst

File metadata and controls

252 lines (169 loc) · 6.52 KB
Raw

CHANGELOG

Version v0.15.2

date

May 29, 2024

  • Small fixes to EthicalAds stickybox placement

Version v0.15.1

date

May 29, 2024

  • Typo in EthicalAds selector

Version v0.15.0

date

May 29, 2024

  • Link to app.readthedocs.org from the flyout to promote the new dashboard more
  • Collapse flyout when clicking outside (this was a regression)
  • Re-enable EthicalAds on all projects with an improved logic (inject them on specific placement or known placement, otherwise stickybox only on wide screens)

Version v0.14.2

date

May 28, 2024

  • Revert rollout of EthicalAd on projects

Version v0.14.1

date

May 28, 2024

  • Update CSS selector for EthicalAd position in Material for MkDocs
  • Update all npm dependencies with with ncu -u

Version v0.14.0

date

May 28, 2024

  • Link to beta.readthedocs.org dashboard from notification
  • Enable EthicalAds in all projects with a house ad ("Coming soon")
  • Always send keywords, campaing and publisher to EthicalAds server
  • Set data-ea-placement only when the flyout is enabled
  • Add UTM analytics parameters to links from the flyout
  • Update all npm dependencies with with ncu -u

Version v0.13.0

date

May 21, 2024

  • EthicalAd injected on docs.readthedocs.io
  • Search hotkey works after open/close it
  • Privacy policy removed from flyout
  • Update all npm dependencies with with ncu -u

Version v0.12.0

date

Apr 16, 2024

  • Notification linking to stable version respects project.versioning_scheme
  • Expose endpoint response data via a JavaScript CustomEvent called readthedocs-addons-data-ready
  • Use api-version=1 when hitting /_/addons/ backend endpoint
  • Update all npm dependencies with with ncu -u

Version v0.11.3

date

Mar 13, 2024

  • Change how visualDomDiff is imported to make it compatible between testing and production environments

Version v0.11.0

date

Mar 12, 2024

  • Hide flyout when triggering the search modal from the flyout input
  • Close the search modal when clicking on a result
  • Allow users to define a custom rootSelector for docdiff
  • Initial implementation for recent searches when opening the search modal
  • Update all npm dependencies with with ncu -u

Version v0.10.0

date

Mar 5, 2024

  • Flyout links keeps the page when switching versions/languages
  • Update all npm dependencies with with ncu -u

Version v0.9.7

date

Feb 22, 2024

  • Fix the flyout code-branch icon position
  • Update all npm dependencies with with ncu -u

Version v0.9.6

date

Feb 20, 2024

  • Replace the v: in the flyout for a code-branch icon
  • Don't loose page position when closing notifications

Version v0.9.5

date

Jan 31, 2024

  • Improve search modal UI design
  • Surround with <strong> the selected language in the flyout
  • Skip pageviews analytics on external versions
  • Update all npm dependencies with with ncu -u

Version v0.9.4

date

Jan 17, 2024

  • Log debug data about validation when running the client in production
  • Allow projects with multiple_versions_without_translations to show the flyout

Version v0.9.3

date

Jan 15, 2024

  • Security fix, more information in GHSA-9v45-336h-5xw5.
  • Update all npm dependencies with with ncu -u

Version v0.9.2

date

December 19, 2023

  • Don't show search input on flyout when search is disabled
  • Update all npm dependencies with with ncu -u

Version v0.9.1

date

November 30, 2023

  • Fix issue with IS_TESTING variable that made the production javascript to hit localhost: for the JSON response instead of production API.

Version v0.9.0

date

November 28, 2023

  • Customize flyout font size via CSS variables
  • NPM packages updated to their latest versions
  • Use JSON schema to validate data from the API
  • Increase test suite for all the addons. Test running inside the browser, checks for HTML and DOM changes, mocked requests and more!
  • Read version_schema field instead single_version from addons API response.

Version v0.8.0

date

November 7, 2023

  • Make flyout header sticky when there are many versions
  • NodeJS packages updated

Version v0.7.2

date

October 31, 2023

  • Show notification only if stable version is available (bugfix in logic)
  • Typos on notification
  • NodeJS packages updated

Version v0.7.1

date

October 25, 2023

  • Show non-stable notification only if stable is enabled
  • Fix issue shown on JS console for global Read the Docs analytics
  • Handle / keyboard shortcut properly when inside on an input

Version v0.7.0

date

October 24, 2023

  • Use objectPath on DocDiff addon to protect ourselves on isEnabled
  • Grab project-slug= and version-slug= from meta HTML tags and send them to the API.
  • Update all the NPM package dependencies

Version v0.6.0

date

September 26, 2023

  • Update pre-commit configuration
  • Update all the NPM package dependencies
  • Don't show "Versions" section in flyout if the project is single version
  • Make notification style better on mobile
  • Don't show notification on single version projects
  • Don't show version name on closed flyout when project is single version
  • Use bumpver to update version on src/utils.js
  • Move HTTP header on requests to API endpoint to GET attribute
  • Switch to web-test-runner to run tests

Version v0.5.0

date

September 17, 2023

  • Add support for scrolling vertically the flyout when there are too many versions
  • Collapse flyout when clicking outside of it
  • Change warning notification logic to show a notification on latest and non-stable versions

Version v0.4.0

date

September 12, 2023

  • Trigger search addon from flyout input
  • Focus search input in the modal immediately after showing it
  • New addons: hotkeys
  • Migrate search hotkeys to be managed by the new hotkeys addon.

Version v0.3.0

date

September 6, 2023

This is the initial published version. Users can access to the addon features by using Read the Docs' config key build.commands. See https://docs.readthedocs.io/en/latest/build-customization.html