diff --git a/docs/applications/escrow-payment/README.md b/docs/applications/escrow-payment/README.md index d6e3a4d5..a630620e 100644 --- a/docs/applications/escrow-payment/README.md +++ b/docs/applications/escrow-payment/README.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Escrow payment CLI The following is a simple Java CLI application to try out and test [ScalarDL](https://github.com/scalar-labs/scalardl). PicoCLI is used as a CLI framework. diff --git a/docs/applications/simple-bank-account/README.md b/docs/applications/simple-bank-account/README.md index a17d0831..f12f4de5 100644 --- a/docs/applications/simple-bank-account/README.md +++ b/docs/applications/simple-bank-account/README.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A simple bank account application ## Overview diff --git a/docs/applications/simple-bank-account/docs/api_endpoints.md b/docs/applications/simple-bank-account/docs/api_endpoints.md index 55a2a80e..d7cbaee8 100644 --- a/docs/applications/simple-bank-account/docs/api_endpoints.md +++ b/docs/applications/simple-bank-account/docs/api_endpoints.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # API endpoints ## `GET v1/accounts` diff --git a/docs/authentication.md b/docs/authentication.md index ed16c2ff..3a7141a5 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Authentication Guide This document explains the ScalarDL authentication mechanism and how to use it properly. diff --git a/docs/backup-restore.md b/docs/backup-restore.md index 57113b76..f545bdd7 100644 --- a/docs/backup-restore.md +++ b/docs/backup-restore.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A Guide on How to Backup and Restore Data in ScalarDL Since ScalarDL uses ScalarDB that provides transaction capability on top of non-transactional (possibly transactional) databases non-invasively, diff --git a/docs/ca/caclient-getting-started.md b/docs/ca/caclient-getting-started.md index 45132869..94f9f413 100644 --- a/docs/ca/caclient-getting-started.md +++ b/docs/ca/caclient-getting-started.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # How to get a certificate This document describes how to get a certificate to enroll in ScalarDL network. diff --git a/docs/ca/caserver-getting-started.md b/docs/ca/caserver-getting-started.md index c9561b2e..c4a98175 100644 --- a/docs/ca/caserver-getting-started.md +++ b/docs/ca/caserver-getting-started.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # How to start CA sever with CFSSL This document describes how to start CA server with CFSSL. diff --git a/docs/compatibility.md b/docs/compatibility.md index cd97743c..da3c9974 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Compatibility Matrix This document shows ScalarDL Ledger and Auditor compatibility with the ScalarDL Java Client SDK. diff --git a/docs/design.md b/docs/design.md index 16c31c62..765b90b6 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL design document Please take a look at the following paper. diff --git a/docs/getting-started-auditor.md b/docs/getting-started-auditor.md index cfcbf36d..66d39e50 100644 --- a/docs/getting-started-auditor.md +++ b/docs/getting-started-auditor.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # Getting Started with ScalarDL Auditor This document explains how to get started with ScalarDL Auditor. diff --git a/docs/getting-started.md b/docs/getting-started.md index c93c73f7..3c3918c0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # Getting Started with ScalarDL This document explains how to get started with ScalarDL by running your first simple contract using the Client SDK. diff --git a/docs/how-to-handle-errors.md b/docs/how-to-handle-errors.md index c0006bb9..a47df231 100644 --- a/docs/how-to-handle-errors.md +++ b/docs/how-to-handle-errors.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A Guide on How to Handle Errors in ScalarDL This document sets out some guidelines for handling errors in ScalarDL. diff --git a/docs/how-to-use-proof.md b/docs/how-to-use-proof.md index 090dcc02..ab9f430c 100644 --- a/docs/how-to-use-proof.md +++ b/docs/how-to-use-proof.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A Guide on How to Use Asset Proofs in ScalarDL This document sets out some guidelines for using Asset Proofs in ScalarDL. diff --git a/docs/how-to-write-contract.md b/docs/how-to-write-contract.md index c651773c..cb5a32e5 100644 --- a/docs/how-to-write-contract.md +++ b/docs/how-to-write-contract.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A Guide on How to Write a Good Contract for ScalarDL This document sets out some guidelines for writing contracts for ScalarDL. diff --git a/docs/how-to-write-function.md b/docs/how-to-write-function.md index 5ce1f402..0a5f0453 100644 --- a/docs/how-to-write-function.md +++ b/docs/how-to-write-function.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # A Guide on How to Write Function for ScalarDL This document sets out some guidelines for writing functions for ScalarDL. diff --git a/docs/implementation.md b/docs/implementation.md index a50fc1e6..64c0b434 100644 --- a/docs/implementation.md +++ b/docs/implementation.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Implementation ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems, which achieves correctness, scalability, and database agnosticism. diff --git a/docs/index.md b/docs/index.md index 650a7bd8..b9d5f991 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Docs ## Design and Implementation diff --git a/docs/installation-with-docker.md b/docs/installation-with-docker.md index 1fa2f9dd..6df2f0da 100644 --- a/docs/installation-with-docker.md +++ b/docs/installation-with-docker.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # How to install ScalarDL in your local environment with Docker This document shows how to set up a local environment that runs ScalarDL diff --git a/docs/javadoc/index.md b/docs/javadoc/index.md index f16413f4..8e7bdd15 100644 --- a/docs/javadoc/index.md +++ b/docs/javadoc/index.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Javadoc * [latest](./latest/index.md) diff --git a/docs/schema-loader.md b/docs/schema-loader.md index 79e94113..acb6a923 100644 --- a/docs/schema-loader.md +++ b/docs/schema-loader.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # ScalarDL Schema Loader A Docker image that loads the database schemas of ScalarDL using [Schema Tool for Scalar DB](https://github.com/scalar-labs/scalardb/tree/master/schema-loader/). diff --git a/docs/trouble-shooting-guide.md b/docs/trouble-shooting-guide.md index c8150a49..be64a895 100644 --- a/docs/trouble-shooting-guide.md +++ b/docs/trouble-shooting-guide.md @@ -1,3 +1,9 @@ +> [!CAUTION] +> +> The `docs` folder has been moved to the centralized documentation repository, [docs-internal](https://github.com/scalar-labs/docs-internal). Please update this documentation in that repository instead. +> +> To view the ScalarDL documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/). + # Trouble-shooting Guilde - [Introduction](#introduction)