From e201907129b1a0211c86ef4fd3cb3373ae7c0be6 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 11:36:10 +0000 Subject: [PATCH 1/6] Fixed SUMMARY.md, renamed README.md --- readme.md => README.md | 0 summary.md => SUMMARY.md | 20 ++++++++++---------- lib/docs-viewer.js | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) rename readme.md => README.md (100%) rename summary.md => SUMMARY.md (98%) diff --git a/readme.md b/README.md similarity index 100% rename from readme.md rename to README.md diff --git a/summary.md b/SUMMARY.md similarity index 98% rename from summary.md rename to SUMMARY.md index 7638662..97df33a 100644 --- a/summary.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [Overview](./readme.md) +* [Pear by Holepunch](./README.md) ### Reference @@ -18,6 +18,15 @@ * [Sharing a Pear Application](./guide/sharing-a-pear-app.md) * [Marking a Release](./guide/releasing-a-pear-app.md) +### How-tos + +* [Connect two peers](./howto/connect-two-peers-by-key-with-hyperdht.md) +* [Connect many peers](./howto/connect-to-many-peers-by-topic-with-hyperswarm.md) +* [Replicate & persist](./howto/replicate-and-persist-with-hypercore.md) +* [Manage multiple Hypercores](./howto/work-with-many-hypercores-using-corestore.md) +* [Share append-only databases](./howto/share-append-only-databases-with-hyperbee.md) +* [Create a p2p filesystem](./howto/create-a-full-peer-to-peer-filesystem-with-hyperdrive.md) + ## Building blocks * [Hypercore](./building-blocks/hypercore.md) @@ -28,15 +37,6 @@ * [Hyperswarm](./building-blocks/hyperswarm.md) -### How-tos - -* [Connect two peers](./howto/connect-two-peers-by-key-with-hyperdht.md) -* [Connect many peers](./howto/connect-to-many-peers-by-topic-with-hyperswarm.md) -* [Replicate & persist](./howto/replicate-and-persist-with-hypercore.md) -* [Manage multiple Hypercores](./howto/work-with-many-hypercores-using-corestore.md) -* [Share append-only databases](./howto/share-append-only-databases-with-hyperbee.md) -* [Create a p2p filesystem](./howto/create-a-full-peer-to-peer-filesystem-with-hyperdrive.md) - ## Helpers * [Corestore](./helpers/corestore.md) diff --git a/lib/docs-viewer.js b/lib/docs-viewer.js index 6654944..e0ec11a 100644 --- a/lib/docs-viewer.js +++ b/lib/docs-viewer.js @@ -58,7 +58,7 @@ customElements.define('docs-viewer', class extends HTMLElement { this.panel = this.root.querySelector('#panel') - this.entry = '/readme.md' + this.entry = '/README.md' const observer = new MutationObserver(() => { if (document.documentElement.classList.contains('light')) this.panel.classList.add('light') From ec44b2f8cd5c48af873b1e96a8b5e5c94b81083b Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 12:16:18 +0000 Subject: [PATCH 2/6] Type fix in compact encoding --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 29705ff..967af81 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ Helper modules can be used together with the building blocks to create cutting-e * [`localdrive`](./helpers/localdrive.md): A file system interoperable with Hyperdrive. * [`mirrordrive`](./helpers/mirrordrive.md): Mirror a [`hyperdrive`](./building-blocks/hyperdrive.md) or a [`localdrive`](./helpers/localdrive.md) into another one. * [`secretstream`](./helpers/secretstream.md): SecretStream is used to securely create connections between two peers in Hyperswarm. -* [compact-`encoding`](./helpers/compact-encoding.md): A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol. +* [`compact-encoding`](./helpers/compact-encoding.md): A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol. * [`protomux`](./helpers/protomux.md): Multiplex multiple message oriented protocols over a stream. ## Tools From 96d5b8577b0cca253c045205945635eeb2092f39 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 13:35:43 +0000 Subject: [PATCH 3/6] Added gitbook config --- .gitbook.yaml | 5 +++++ README.md => readme.md | 0 SUMMARY.md => summary.md | 0 3 files changed, 5 insertions(+) create mode 100644 .gitbook.yaml rename README.md => readme.md (100%) rename SUMMARY.md => summary.md (100%) diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000..f6a3163 --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,5 @@ +root: ./ + +​structure: + readme: readme.md + summary: summary.md​ \ No newline at end of file diff --git a/README.md b/readme.md similarity index 100% rename from README.md rename to readme.md diff --git a/SUMMARY.md b/summary.md similarity index 100% rename from SUMMARY.md rename to summary.md From bb1ebb7d63aa1bc15665fcf633f4f0398369b469 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 13:48:18 +0000 Subject: [PATCH 4/6] gitbook config fix --- .gitbook.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitbook.yaml b/.gitbook.yaml index f6a3163..d14e979 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -2,4 +2,7 @@ root: ./ ​structure: readme: readme.md - summary: summary.md​ \ No newline at end of file + summary: summary.md​ + +redirects: + pear: readme.md \ No newline at end of file From ff19427d02089cd652e332efa084f77cc0e07dd0 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 14:27:51 +0000 Subject: [PATCH 5/6] Removed gitbook config --- summary.md => SUMMARY.md | 2 +- lib/docs-viewer.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename summary.md => SUMMARY.md (98%) diff --git a/summary.md b/SUMMARY.md similarity index 98% rename from summary.md rename to SUMMARY.md index 97df33a..678621d 100644 --- a/summary.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [Pear by Holepunch](./README.md) +* [Pear by Holepunch](./readme.md) ### Reference diff --git a/lib/docs-viewer.js b/lib/docs-viewer.js index e0ec11a..6654944 100644 --- a/lib/docs-viewer.js +++ b/lib/docs-viewer.js @@ -58,7 +58,7 @@ customElements.define('docs-viewer', class extends HTMLElement { this.panel = this.root.querySelector('#panel') - this.entry = '/README.md' + this.entry = '/readme.md' const observer = new MutationObserver(() => { if (document.documentElement.classList.contains('light')) this.panel.classList.add('light') From 49005880a2c9134af741dfede5f66a434fcb8268 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Tue, 13 Feb 2024 14:39:54 +0000 Subject: [PATCH 6/6] Removed .gitbook.yaml --- .gitbook.yaml | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 .gitbook.yaml diff --git a/.gitbook.yaml b/.gitbook.yaml deleted file mode 100644 index d14e979..0000000 --- a/.gitbook.yaml +++ /dev/null @@ -1,8 +0,0 @@ -root: ./ - -​structure: - readme: readme.md - summary: summary.md​ - -redirects: - pear: readme.md \ No newline at end of file