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

Use custom banners instead of deprecated admonitions #1159

Merged
merged 3 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions banners/iota-streams-deprecated.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Streams and this documentation are no longer actively maintained.
File renamed without changes.
17 changes: 16 additions & 1 deletion contentPlugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ module.exports = async () => {
id: 'iota-rs-2-0-1-rc-7',
path: path.resolve(__dirname, 'docs/build/iota.rs/2.0.1-rc.7/docs'),
routeBasePath: 'iota.rs',
bannerPath: path.resolve(
__dirname,
'banners/pre-sdk-libs-deprecated.mdx',
),
sidebarPath: path.resolve(
__dirname,
'docs/build/iota.rs/2.0.1-rc.7/sidebars.js',
Expand All @@ -134,7 +138,10 @@ module.exports = async () => {
id: 'iotajs',
path: path.resolve(__dirname, 'docs/build/iota.js/2.0.0-rc.1/docs'),
routeBasePath: 'iota.js',
bannerPath: path.resolve(__dirname, 'banners/iota-js-deprecated.mdx'),
bannerPath: path.resolve(
__dirname,
'banners/pre-sdk-libs-deprecated.mdx',
),
sidebarPath: path.resolve(
__dirname,
'docs/build/iota.js/2.0.0-rc.1/sidebars.js',
Expand All @@ -159,6 +166,10 @@ module.exports = async () => {
id: 'wallet-rs-1-0-0-rc-6',
path: path.resolve(__dirname, 'docs/build/wallet.rs/1.0.0-rc.6/docs'),
routeBasePath: 'wallet.rs',
bannerPath: path.resolve(
__dirname,
'banners/pre-sdk-libs-deprecated.mdx',
),
sidebarPath: path.resolve(
__dirname,
'docs/build/wallet.rs/1.0.0-rc.6/sidebars.js',
Expand Down Expand Up @@ -191,6 +202,10 @@ module.exports = async () => {
id: 'iota-streams',
path: path.resolve(__dirname, 'docs/build/streams/0.2.0/docs'),
routeBasePath: 'streams',
bannerPath: path.resolve(
__dirname,
'banners/iota-streams-deprecated.mdx',
),
sidebarPath: path.resolve(
__dirname,
'docs/build/streams/0.2.0/sidebars.js',
Expand Down
5 changes: 0 additions & 5 deletions docs/build/iota.js/2.0.0-rc.1/docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ keywords:

# Welcome

:::caution
This is documentation for iota.js, which is no longer actively maintained.
For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
:::

The iota.js client library is implemented in TypeScript to strongly type the objects sent and received from the API. You
can use it in both NodeJs and Browser environments. You can use the client library to handle communications between your
software and the IOTA network.
Expand Down
5 changes: 0 additions & 5 deletions docs/build/iota.rs/2.0.1-rc.7/docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ keywords:
- explanation
---

:::caution
This is documentation for iota.rs, which is no longer actively maintained.
For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
:::

# Welcome

![IOTA Client Library](/img/Banner/banner_client_lib.png)
Expand Down
4 changes: 0 additions & 4 deletions docs/build/streams/0.2.0/docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ keywords:

# Welcome

:::caution
This is documentation for Streams, which is no longer actively maintained.
:::

This is the documentation for the official IOTA Streams software. You can read more about core principles behind IOTA Streams in the following blog [post](https://blog.iota.org/iota-streams-alpha-7e91ee326ac0/).

Streams is an organizational tool for structuring and navigating secure data through the Tangle. Streams organizes data by ordering it in a uniform and interoperable structure. Needless to say, it is also based on our official _one source code of truth_ [IOTA Rust library](https://github.com/iotaledger/iota.rs).
Expand Down
5 changes: 0 additions & 5 deletions docs/build/wallet.rs/1.0.0-rc.6/docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ keywords:

# Welcome

:::caution
This is documentation for wallet.rs, which is no longer actively maintained.
For up-to-date documentation, see the documentation for its successor the [IOTA SDK](/iota-sdk/welcome).
:::

This is the documentation for the official IOTA Wallet Library Software. The documentation can be used to easily integrate an IOTA Wallet into your applications. You can read more about core principles behind IOTA client libraries in the following [blog post](https://blog.iota.org/the-new-iota-client-libraries-harder-better-faster-stronger/).

`wallet.rs` is a general wallet library written in Rust. It is being utilized by our wallet software `Firefly` and other software components across IOTA ecosystem. `wallet.rs` contains all the logic to safely build wallets or integrations that require value-based transfers (such as exchanges, pay-as-you-go systems, etc.). `wallet.rs` includes account state management and backup, account creation, transferring tokens and much more. Needless to say, it is also based on our official _one-source-code-of-truth_ [IOTA Rust library](https://github.com/iotaledger/wallet.rs) and can be integrated with the [Stronghold enclave](https://blog.iota.org/iota-stronghold-6ce55d311d7c/) to achieve a maximum level of security.
Expand Down
6 changes: 6 additions & 0 deletions docs/build/wasp/0.7.0/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ keywords:

![Wasp Node](/img/Banner/banner_wasp.png)

:::caution

Smart Contracts are currently only compatible with the stardust update and therefore only compatible with the Shimmer main- and testnetwork.

:::

IOTA Smart Contracts (ISC) is a platform that brings scalable and flexible smart contracts into the IOTA ecosystem. It
allows anyone to spin up a smart contract blockchain and anchor it to the IOTA Tangle, a design that offers multiple
advantages.
Expand Down