From 0200efa6e0b62af8566ee54186c58fb4255bfe1a Mon Sep 17 00:00:00 2001 From: Josh Wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 24 Apr 2025 15:16:08 +0900 Subject: [PATCH 1/5] Replace docs site link with links to multiple docs --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f616cb59..22b66f65 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,18 @@ ScalarDL is a scalable and practical Byzantine fault detection middleware for transactional database systems that achieves correctness, scalability, and database agnosticism. -## Docs -* [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/) -* [ScalarDL Technical Overview](https://speakerdeck.com/scalar/scalar-dl-technical-overview) -* [ScalarDL Research Paper](https://dl.acm.org/doi/abs/10.14778/3523210.3523212) [VLDB'22] +## Quickstart + +1. Start running contracts. + - **Get started with ScalarDL Ledger:** To set up a basic application and run contracts by using ScalarDL Ledger, see [Get Started with ScalarDL Ledger](https://scalardl.scalar-labs.com/docs/latest/getting-started). + - **Get started with ScalarDL Ledger and Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then uses ScalarDL Auditor to detect whether those contracts have been tampered with, see [Get Started with ScalarDL Ledger and Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor). +2. See how to set up [a simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account). +3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations) +4. Learn about features, such as: + - [Authentication](https://scalardl.scalar-labs.com/docs/latest/authentication) + - [Generic contracts](https://scalardl.scalar-labs.com/docs/latest/use-generic-contracts) + +For additional documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/). ## Contributing ScalarDL is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help. From 26f65070ed34b2dfe2eb8b2ba992fd78ebbcc009 Mon Sep 17 00:00:00 2001 From: Josh Wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 24 Apr 2025 15:16:43 +0900 Subject: [PATCH 2/5] Add link to overview doc under intro paragraph --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 22b66f65..3b2013d3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ScalarDL is a scalable and practical Byzantine fault detection middleware for transactional database systems that achieves correctness, scalability, and database agnosticism. +To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/latest/overview). + ## Quickstart 1. Start running contracts. From e67972a922379959dcafff078b1483c9bcb42d2b Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Fri, 25 Apr 2025 12:13:36 +0900 Subject: [PATCH 3/5] Apply suggestions from code review [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b2013d3..3d779081 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/lat 1. Start running contracts. - **Get started with ScalarDL Ledger:** To set up a basic application and run contracts by using ScalarDL Ledger, see [Get Started with ScalarDL Ledger](https://scalardl.scalar-labs.com/docs/latest/getting-started). - - **Get started with ScalarDL Ledger and Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then uses ScalarDL Auditor to detect whether those contracts have been tampered with, see [Get Started with ScalarDL Ledger and Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor). + - **Get started with ScalarDL Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then use ScalarDL Auditor to detect whether those contracts have been tampered with, see [Getting Started with ScalarDL Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor). 2. See how to set up [a simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account). 3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations) 4. Learn about features, such as: From b9e8b04977ccf1ee28b92736ffda6011c88e15f3 Mon Sep 17 00:00:00 2001 From: Josh Wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 May 2025 16:01:55 +0900 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3d779081..c7e202aa 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/lat 1. Start running contracts. - **Get started with ScalarDL Ledger:** To set up a basic application and run contracts by using ScalarDL Ledger, see [Get Started with ScalarDL Ledger](https://scalardl.scalar-labs.com/docs/latest/getting-started). - **Get started with ScalarDL Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then use ScalarDL Auditor to detect whether those contracts have been tampered with, see [Getting Started with ScalarDL Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor). -2. See how to set up [a simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account). +2. See how to set up a [simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account). 3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations) 4. Learn about features, such as: - [Authentication](https://scalardl.scalar-labs.com/docs/latest/authentication) - [Generic contracts](https://scalardl.scalar-labs.com/docs/latest/use-generic-contracts) -For additional documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/). +For additional documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest). ## Contributing ScalarDL is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help. From b107fe18f334d11f8178758ac0801ea2ac07ea47 Mon Sep 17 00:00:00 2001 From: Josh Wong <23216828+josh-wong@users.noreply.github.com> Date: Thu, 8 May 2025 16:16:10 +0900 Subject: [PATCH 5/5] Add links to design and implementation docs --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7e202aa..55099ee9 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/lat - **Get started with ScalarDL Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then use ScalarDL Auditor to detect whether those contracts have been tampered with, see [Getting Started with ScalarDL Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor). 2. See how to set up a [simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account). 3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations) -4. Learn about features, such as: +4. Learn about ScalarDL and its features: + - [ScalarDL design](https://scalardl.scalar-labs.com/docs/latest/design) + - [ScalarDL implementation](https://scalardl.scalar-labs.com/docs/latest/implementation) - [Authentication](https://scalardl.scalar-labs.com/docs/latest/authentication) - [Generic contracts](https://scalardl.scalar-labs.com/docs/latest/use-generic-contracts)