From de7bd5b954bdcb87725856ad0fa600803791fe29 Mon Sep 17 00:00:00 2001 From: Rodi-Can Bozman Date: Wed, 28 May 2025 15:16:28 +0200 Subject: [PATCH 1/3] README: update doc for interface --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b0c8691..76fe792 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,10 @@ Visit our website at **[openpandora.io](https://openpandora.io/)** to learn more - `crates` – Contains generic libraries for modular development aimed for the kernel. (**Rust**) - `doc` – Documentation for the infrastructure and the API server. (**Markdown, HTML**) - `inputs` – Testing data for the wasm debugger. (**JSon**) +- `interface` – Web app (UI, API, DB) of Pandora, to interact with the system via a convenient web interface. (**OCaml**) - `kernel` – Core execution engine of Pandora handling the low-level operations. (**Rust**) - `scripts` – Automation scripts for deployment, dependencies, or setup. (**bash**) - `server` – Pandora's API server. (**OCaml**) -- `ui` – Frontend of Pandora, to interact with the system via a convenient web interface. (**OCaml**) ## Setting up dependencies -- GitLab From 1a78f81a8a3e769660c000d31a1614cb2ad04621 Mon Sep 17 00:00:00 2001 From: Rodi-Can Bozman Date: Wed, 28 May 2025 15:17:44 +0200 Subject: [PATCH 2/3] Scripts: move parallel notarization script --- scripts/README.md | 2 +- {script => scripts}/parallel_notarize.sh | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {script => scripts}/parallel_notarize.sh (100%) diff --git a/scripts/README.md b/scripts/README.md index f20e0ea..85f61ee 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -40,5 +40,5 @@ pip install base58 ## Parallel Notarize ```sh -.parallel_notarize.sh --hash-amount --interval --api --parallel-execution --base-script-path +./parallel_notarize.sh --hash-amount --interval --api --parallel-execution --base-script-path ``` diff --git a/script/parallel_notarize.sh b/scripts/parallel_notarize.sh similarity index 100% rename from script/parallel_notarize.sh rename to scripts/parallel_notarize.sh -- GitLab From 7609cdfe393cfd6c24e9b0e726eb06050fa59853 Mon Sep 17 00:00:00 2001 From: Rodi-Can Bozman Date: Wed, 28 May 2025 15:21:46 +0200 Subject: [PATCH 3/3] README: rewording --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 76fe792..8a2a4f3 100644 --- a/README.md +++ b/README.md @@ -157,17 +157,15 @@ Recompile make interface ``` -## Running Pandora - Technical documentation +## Pandora - Documentation -See the [infrastructure document](doc/infrastructure.md) for deploying the -Pandora rollup and running the necessary infrastructure. +See our [General Documentation](https://openpandora.io/documentation.html) for a quick start and general overview of Pandora's capabilities. -See the [server documentation](doc/server.md) for running and interacting with -the Pandora API server. +See our [Infrastructure Documentation](doc/infrastructure.md) to deploy Pandora's rollup and running the necessary infrastructure. -See our [Technical -Documentation](https://www.functori.com/docs/pandora/introduction.html) to dive -deeper into the technical aspects. +See our [Server Documentation](doc/server.md) to run and interact with Pandora's API server. + +See our [Technical Documentation](https://www.functori.com/docs/pandora/introduction.html) to dive deeper into the technical aspects. ## Contributing and Support -- GitLab