From 7837587a66f6a991d9aa02362748b0cf65ccb199 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 22 Jan 2024 11:49:23 +0900 Subject: [PATCH 1/3] Add attention notice about doc relocation [skip ci] --- docs/applications/escrow-payment/README.md | 4 ++++ docs/applications/simple-bank-account/README.md | 4 ++++ docs/applications/simple-bank-account/docs/api_endpoints.md | 4 ++++ docs/authentication.md | 4 ++++ docs/backup-restore.md | 4 ++++ docs/ca/caclient-getting-started.md | 4 ++++ docs/ca/caserver-getting-started.md | 4 ++++ docs/compatibility.md | 4 ++++ docs/design.md | 4 ++++ docs/getting-started-auditor.md | 4 ++++ docs/getting-started.md | 4 ++++ docs/how-to-handle-errors.md | 4 ++++ docs/how-to-use-proof.md | 4 ++++ docs/how-to-write-contract.md | 4 ++++ docs/how-to-write-function.md | 4 ++++ docs/implementation.md | 4 ++++ docs/index.md | 4 ++++ docs/installation-with-docker.md | 4 ++++ docs/javadoc/index.md | 4 ++++ docs/schema-loader.md | 4 ++++ docs/trouble-shooting-guide.md | 4 ++++ 21 files changed, 84 insertions(+) diff --git a/docs/applications/escrow-payment/README.md b/docs/applications/escrow-payment/README.md index d6e3a4d5..33cbcaf2 100644 --- a/docs/applications/escrow-payment/README.md +++ b/docs/applications/escrow-payment/README.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..0e78f2da 100644 --- a/docs/applications/simple-bank-account/README.md +++ b/docs/applications/simple-bank-account/README.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..a720f9ee 100644 --- a/docs/applications/simple-bank-account/docs/api_endpoints.md +++ b/docs/applications/simple-bank-account/docs/api_endpoints.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # API endpoints ## `GET v1/accounts` diff --git a/docs/authentication.md b/docs/authentication.md index ed16c2ff..8d66c6c1 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..75674a61 100644 --- a/docs/backup-restore.md +++ b/docs/backup-restore.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..3363991a 100644 --- a/docs/ca/caclient-getting-started.md +++ b/docs/ca/caclient-getting-started.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..6bf21280 100644 --- a/docs/ca/caserver-getting-started.md +++ b/docs/ca/caserver-getting-started.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..add017b0 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..19a1da1e 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..44a8c98c 100644 --- a/docs/getting-started-auditor.md +++ b/docs/getting-started-auditor.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..a540009a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..ab83018b 100644 --- a/docs/how-to-handle-errors.md +++ b/docs/how-to-handle-errors.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..e0b3b44b 100644 --- a/docs/how-to-use-proof.md +++ b/docs/how-to-use-proof.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..579462b6 100644 --- a/docs/how-to-write-contract.md +++ b/docs/how-to-write-contract.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..178097df 100644 --- a/docs/how-to-write-function.md +++ b/docs/how-to-write-function.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..446eda57 100644 --- a/docs/implementation.md +++ b/docs/implementation.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..99f43cfe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # ScalarDL Docs ## Design and Implementation diff --git a/docs/installation-with-docker.md b/docs/installation-with-docker.md index 1fa2f9dd..929650e2 100644 --- a/docs/installation-with-docker.md +++ b/docs/installation-with-docker.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..9233f81f 100644 --- a/docs/javadoc/index.md +++ b/docs/javadoc/index.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # ScalarDL Javadoc * [latest](./latest/index.md) diff --git a/docs/schema-loader.md b/docs/schema-loader.md index 79e94113..ad6b55d9 100644 --- a/docs/schema-loader.md +++ b/docs/schema-loader.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # 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..6f6a5f4f 100644 --- a/docs/trouble-shooting-guide.md +++ b/docs/trouble-shooting-guide.md @@ -1,3 +1,7 @@ +> [!ATTENTION] +> +> 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. + # Trouble-shooting Guilde - [Introduction](#introduction) From 757c0ed97b95c194966c4c58488d4e9f6d90e082 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 22 Jan 2024 17:27:14 +0900 Subject: [PATCH 2/3] Fix admonition name Fix admonition name. "Attention" is not a valid admonition name in GitHub. --- docs/applications/escrow-payment/README.md | 2 +- docs/applications/simple-bank-account/README.md | 2 +- docs/applications/simple-bank-account/docs/api_endpoints.md | 2 +- docs/authentication.md | 2 +- docs/backup-restore.md | 2 +- docs/ca/caclient-getting-started.md | 2 +- docs/ca/caserver-getting-started.md | 2 +- docs/compatibility.md | 2 +- docs/design.md | 2 +- docs/getting-started-auditor.md | 2 +- docs/getting-started.md | 2 +- docs/how-to-handle-errors.md | 2 +- docs/how-to-use-proof.md | 2 +- docs/how-to-write-contract.md | 2 +- docs/how-to-write-function.md | 2 +- docs/implementation.md | 2 +- docs/index.md | 2 +- docs/installation-with-docker.md | 2 +- docs/javadoc/index.md | 2 +- docs/schema-loader.md | 2 +- docs/trouble-shooting-guide.md | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/applications/escrow-payment/README.md b/docs/applications/escrow-payment/README.md index 33cbcaf2..9d0bf392 100644 --- a/docs/applications/escrow-payment/README.md +++ b/docs/applications/escrow-payment/README.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/applications/simple-bank-account/README.md b/docs/applications/simple-bank-account/README.md index 0e78f2da..640f8c04 100644 --- a/docs/applications/simple-bank-account/README.md +++ b/docs/applications/simple-bank-account/README.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/applications/simple-bank-account/docs/api_endpoints.md b/docs/applications/simple-bank-account/docs/api_endpoints.md index a720f9ee..56785acc 100644 --- a/docs/applications/simple-bank-account/docs/api_endpoints.md +++ b/docs/applications/simple-bank-account/docs/api_endpoints.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/authentication.md b/docs/authentication.md index 8d66c6c1..03d9499c 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/backup-restore.md b/docs/backup-restore.md index 75674a61..d7ff3443 100644 --- a/docs/backup-restore.md +++ b/docs/backup-restore.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/ca/caclient-getting-started.md b/docs/ca/caclient-getting-started.md index 3363991a..43bf8812 100644 --- a/docs/ca/caclient-getting-started.md +++ b/docs/ca/caclient-getting-started.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/ca/caserver-getting-started.md b/docs/ca/caserver-getting-started.md index 6bf21280..c3a57ef2 100644 --- a/docs/ca/caserver-getting-started.md +++ b/docs/ca/caserver-getting-started.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/compatibility.md b/docs/compatibility.md index add017b0..9a4346a3 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/design.md b/docs/design.md index 19a1da1e..d0883d9c 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/getting-started-auditor.md b/docs/getting-started-auditor.md index 44a8c98c..bc5f5d28 100644 --- a/docs/getting-started-auditor.md +++ b/docs/getting-started-auditor.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/getting-started.md b/docs/getting-started.md index a540009a..7a45ebfd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/how-to-handle-errors.md b/docs/how-to-handle-errors.md index ab83018b..a97bce6f 100644 --- a/docs/how-to-handle-errors.md +++ b/docs/how-to-handle-errors.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/how-to-use-proof.md b/docs/how-to-use-proof.md index e0b3b44b..f1582c2d 100644 --- a/docs/how-to-use-proof.md +++ b/docs/how-to-use-proof.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/how-to-write-contract.md b/docs/how-to-write-contract.md index 579462b6..db23f42a 100644 --- a/docs/how-to-write-contract.md +++ b/docs/how-to-write-contract.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/how-to-write-function.md b/docs/how-to-write-function.md index 178097df..f23b1266 100644 --- a/docs/how-to-write-function.md +++ b/docs/how-to-write-function.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/implementation.md b/docs/implementation.md index 446eda57..2ab17b9b 100644 --- a/docs/implementation.md +++ b/docs/implementation.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/index.md b/docs/index.md index 99f43cfe..b2a01ac7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/installation-with-docker.md b/docs/installation-with-docker.md index 929650e2..39753249 100644 --- a/docs/installation-with-docker.md +++ b/docs/installation-with-docker.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/javadoc/index.md b/docs/javadoc/index.md index 9233f81f..fdf36758 100644 --- a/docs/javadoc/index.md +++ b/docs/javadoc/index.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/schema-loader.md b/docs/schema-loader.md index ad6b55d9..70976686 100644 --- a/docs/schema-loader.md +++ b/docs/schema-loader.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. diff --git a/docs/trouble-shooting-guide.md b/docs/trouble-shooting-guide.md index 6f6a5f4f..19de90e7 100644 --- a/docs/trouble-shooting-guide.md +++ b/docs/trouble-shooting-guide.md @@ -1,4 +1,4 @@ -> [!ATTENTION] +> [!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. From e600134709a67f82679f5a093ab312fddaceb804 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Tue, 23 Jan 2024 10:25:56 +0900 Subject: [PATCH 3/3] Add link to ScalarDL docs site --- docs/applications/escrow-payment/README.md | 2 ++ docs/applications/simple-bank-account/README.md | 2 ++ docs/applications/simple-bank-account/docs/api_endpoints.md | 2 ++ docs/authentication.md | 2 ++ docs/backup-restore.md | 2 ++ docs/ca/caclient-getting-started.md | 2 ++ docs/ca/caserver-getting-started.md | 2 ++ docs/compatibility.md | 2 ++ docs/design.md | 2 ++ docs/getting-started-auditor.md | 2 ++ docs/getting-started.md | 2 ++ docs/how-to-handle-errors.md | 2 ++ docs/how-to-use-proof.md | 2 ++ docs/how-to-write-contract.md | 2 ++ docs/how-to-write-function.md | 2 ++ docs/implementation.md | 2 ++ docs/index.md | 2 ++ docs/installation-with-docker.md | 2 ++ docs/javadoc/index.md | 2 ++ docs/schema-loader.md | 2 ++ docs/trouble-shooting-guide.md | 2 ++ 21 files changed, 42 insertions(+) diff --git a/docs/applications/escrow-payment/README.md b/docs/applications/escrow-payment/README.md index 9d0bf392..a630620e 100644 --- a/docs/applications/escrow-payment/README.md +++ b/docs/applications/escrow-payment/README.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/applications/simple-bank-account/README.md b/docs/applications/simple-bank-account/README.md index 640f8c04..f12f4de5 100644 --- a/docs/applications/simple-bank-account/README.md +++ b/docs/applications/simple-bank-account/README.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/applications/simple-bank-account/docs/api_endpoints.md b/docs/applications/simple-bank-account/docs/api_endpoints.md index 56785acc..d7cbaee8 100644 --- a/docs/applications/simple-bank-account/docs/api_endpoints.md +++ b/docs/applications/simple-bank-account/docs/api_endpoints.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/authentication.md b/docs/authentication.md index 03d9499c..3a7141a5 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/backup-restore.md b/docs/backup-restore.md index d7ff3443..f545bdd7 100644 --- a/docs/backup-restore.md +++ b/docs/backup-restore.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/ca/caclient-getting-started.md b/docs/ca/caclient-getting-started.md index 43bf8812..94f9f413 100644 --- a/docs/ca/caclient-getting-started.md +++ b/docs/ca/caclient-getting-started.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/ca/caserver-getting-started.md b/docs/ca/caserver-getting-started.md index c3a57ef2..c4a98175 100644 --- a/docs/ca/caserver-getting-started.md +++ b/docs/ca/caserver-getting-started.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/compatibility.md b/docs/compatibility.md index 9a4346a3..da3c9974 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/design.md b/docs/design.md index d0883d9c..765b90b6 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/getting-started-auditor.md b/docs/getting-started-auditor.md index bc5f5d28..66d39e50 100644 --- a/docs/getting-started-auditor.md +++ b/docs/getting-started-auditor.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/getting-started.md b/docs/getting-started.md index 7a45ebfd..3c3918c0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/how-to-handle-errors.md b/docs/how-to-handle-errors.md index a97bce6f..a47df231 100644 --- a/docs/how-to-handle-errors.md +++ b/docs/how-to-handle-errors.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/how-to-use-proof.md b/docs/how-to-use-proof.md index f1582c2d..ab9f430c 100644 --- a/docs/how-to-use-proof.md +++ b/docs/how-to-use-proof.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/how-to-write-contract.md b/docs/how-to-write-contract.md index db23f42a..cb5a32e5 100644 --- a/docs/how-to-write-contract.md +++ b/docs/how-to-write-contract.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/how-to-write-function.md b/docs/how-to-write-function.md index f23b1266..0a5f0453 100644 --- a/docs/how-to-write-function.md +++ b/docs/how-to-write-function.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/implementation.md b/docs/implementation.md index 2ab17b9b..64c0b434 100644 --- a/docs/implementation.md +++ b/docs/implementation.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/index.md b/docs/index.md index b2a01ac7..b9d5f991 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/installation-with-docker.md b/docs/installation-with-docker.md index 39753249..6df2f0da 100644 --- a/docs/installation-with-docker.md +++ b/docs/installation-with-docker.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/javadoc/index.md b/docs/javadoc/index.md index fdf36758..8e7bdd15 100644 --- a/docs/javadoc/index.md +++ b/docs/javadoc/index.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/schema-loader.md b/docs/schema-loader.md index 70976686..acb6a923 100644 --- a/docs/schema-loader.md +++ b/docs/schema-loader.md @@ -1,6 +1,8 @@ > [!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 diff --git a/docs/trouble-shooting-guide.md b/docs/trouble-shooting-guide.md index 19de90e7..be64a895 100644 --- a/docs/trouble-shooting-guide.md +++ b/docs/trouble-shooting-guide.md @@ -1,6 +1,8 @@ > [!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