From 01bb7680e9339bb8cb9d4ad6d3998602f6d3dcf0 Mon Sep 17 00:00:00 2001 From: Tiago <70700766+tiagorangel1@users.noreply.github.com> Date: Sun, 8 Jun 2025 17:02:05 +0100 Subject: [PATCH] docs: slight improvements --- docs/.vitepress/config.mjs | 8 ++++---- docs/guide/benchmark.md | 4 +++- docs/guide/demo.md | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 12ad780..a48f1e8 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -151,7 +151,6 @@ export default withMermaid({ sidebar: [ { text: "Quickstart", link: "/guide/index.md" }, { text: "Feature comparison", link: "/guide/alternatives.md" }, - { text: "Philosophy", link: "/guide/philosophy.md" }, { text: "Modes", collapsed: false, @@ -172,8 +171,8 @@ export default withMermaid({ ], }, { - text: "Checkpoints", - collapsed: false, + text: "Checkpoint", + collapsed: true, items: [ { text: "About", link: "/guide/middleware/index.md" }, { text: "Elysia", link: "/guide/middleware/elysia.md" }, @@ -183,10 +182,11 @@ export default withMermaid({ }, { text: "Proof-of-work", - collapsed: false, + collapsed: true, items: [ { text: "Effectiveness", link: "/guide/effectiveness.md" }, { text: "How does it work", link: "/guide/workings.md" }, + { text: "Philosophy", link: "/guide/philosophy.md" }, ], }, { text: "Benchmark", link: "/guide/benchmark.md" }, diff --git a/docs/guide/benchmark.md b/docs/guide/benchmark.md index 3fffc16..312fc2c 100644 --- a/docs/guide/benchmark.md +++ b/docs/guide/benchmark.md @@ -20,4 +20,6 @@ Tested with BrowserStack using the following configuration: - **Challenge difficulty:** 4 - **Number of challenges:** 50 - **Salt/challenge size:** 32 -- **Number of benchmarks:** 50 \ No newline at end of file +- **Number of benchmarks:** 50 + +Note that this benchmark uses a placeholder server and that the actual speed might vary in production depending on network latency. \ No newline at end of file diff --git a/docs/guide/demo.md b/docs/guide/demo.md index 9de88e6..e940eca 100644 --- a/docs/guide/demo.md +++ b/docs/guide/demo.md @@ -17,4 +17,4 @@ -You can find demos for a lot of more stuff [inside the demo folder](https://github.com/tiagorangel1/cap/tree/main/demo) on the GitHub repo. \ No newline at end of file +You can find more demos [in the GitHub repo](https://github.com/tiagorangel1/cap/tree/main/demo). Note that this demo is not a full implementation of Cap and uses a placeholder server. \ No newline at end of file