Skip to content

Commit

Permalink
Add 1.x deprecation notice (#6723)
Browse files Browse the repository at this point in the history
* add Maintenance notes

* add links
  • Loading branch information
avkos committed Jan 15, 2024
1 parent 0e8695b commit 5b33133
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
## Maintenance Countdown:
Commencing from January 1, 2024, a 90-day countdown has been initiated, signaling the transition of Web3.js version 1.x into an end-of-maintenance phase.

### Timeline of Changes:

- 90-Day Countdown (1/1/24 - 3/31/24):
During this period, we strongly encourage users to plan accordingly and initiate the [upgrade to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/)

- No New Bug Fixes (4/1/24 onwards):
Starting April 1, 2024, new bug fixes for Web3.js version 1.x will no longer be provided. To benefit from continued support and access to new features, we recommend [upgrading to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/)

- End of Security Fixes (7/1/24):
Security fixes for Web3.js version 1.x will be discontinued from July 1, 2024. [Upgrading to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/) is crucial to ensure the security of your applications.


<p style="text-align: center;">
<img src="assets/logo/web3js.jpg" width="200" alt="web3.js">
</p>
Expand Down
20 changes: 18 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
=================================
Maintenance Countdown:
=================================

Commencing from January 1, 2024, a 90-day countdown has been initiated, signaling the transition of Web3.js version 1.x into an end-of-maintenance phase.

---------------------
Timeline of Changes:
---------------------

- 90-Day Countdown (1/1/24 - 3/31/24): During this period, we strongly encourage users to plan accordingly and initiate the `upgrade to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_

- No New Bug Fixes (4/1/24 onwards): Starting April 1, 2024, new bug fixes for Web3.js version 1.x will no longer be provided. To benefit from continued support and access to new features, we recommend `upgrading to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_

- End of Security Fixes (7/1/24): Security fixes for Web3.js version 1.x will be discontinued from July 1, 2024. `Upgrading to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_ is crucial to ensure the security of your applications


=================================
web3.js - Ethereum JavaScript API
Expand All @@ -7,7 +23,7 @@ web3.js is a collection of libraries that allow you to interact with a local or

The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>` as well as providing an :ref:`API reference documentation <#id1>` with examples.

.. note:: `Web3.js 4.x <https://www.npmjs.com/package/web3>`_ has been released. Checkout 4.x `API documentation and migration guide <https://docs.web3js.org/>`_ .
.. note:: `Web3.js 4.x <https://www.npmjs.com/package/web3>`_ has been released. Checkout 4.x `API documentation and migration guide <https://docs.web3js.org/>`_ .

Contents:

Expand Down Expand Up @@ -42,4 +58,4 @@ Contents:
web3-admin


Special thanks to `Netlify <https://www.netlify.com/>`_ for providing build and deploy services for our end-to-end integration tests.
Special thanks to `Netlify <https://www.netlify.com/>`_ for providing build and deploy services for our end-to-end integration tests.

0 comments on commit 5b33133

Please sign in to comment.