From d814c29c30bb2fd7f27559b8859d8268868d9e3d Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Tue, 21 Mar 2023 21:32:23 +1100 Subject: [PATCH 1/3] Fix social links --- docusaurus.config.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 9ae8566..f1fd39e 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -60,22 +60,22 @@ const config = { { title: "Community", items: [ - { - href: "https://stackoverflow.com/questions/tagged/docusaurus", - label: "Stack Overflow", - }, { href: "https://forum.vac.dev/", label: "Discourse", }, { - href: "https://discord.gg/j5pGbn7MHZ", - label: "Twitter", + href: "https://discord.gg/Nrac59MfSX", + label: "Discord", }, { href: "https://twitter.com/waku_org", label: "Twitter", }, + { + href: "https://t.me/waku_org", + label: "Telegram", + }, ], }, ], From d8b256f5c02d0bd0e1d29423b87346666bda29c4 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Tue, 21 Mar 2023 22:08:00 +1100 Subject: [PATCH 2/3] Add section for JavaScript documentation --- docs/browser/introduction.md | 5 +++ .../concepts}/content-topics.md | 0 .../concepts}/different-protocols.md | 0 .../concepts}/discovery-and-bootstrap.md | 0 .../concepts}/protocols-explained.md | 0 .../protocols-overview-by-example.md | 0 .../concepts}/research-in-progress.md | 0 .../concepts}/security-features.md | 0 .../concepts}/transports-in-waku.md | 0 .../concepts}/waku-vs-libp2p.md | 0 docs/{ => main}/history.md | 0 docs/{ => main}/how-does-it-work.md | 0 docs/{ => main}/implementations.md | 0 docs/{ => main}/introduction.md | 0 docs/{ => main}/motivation-and-goals.md | 0 docs/{ => main}/who-is-using-waku.md | 0 docs/{ => main}/why-waku.md | 0 docusaurus.config.js | 13 +++++-- sidebars.js | 37 ++++++++++--------- 19 files changed, 35 insertions(+), 20 deletions(-) create mode 100644 docs/browser/introduction.md rename docs/{Concepts => main/concepts}/content-topics.md (100%) rename docs/{Concepts => main/concepts}/different-protocols.md (100%) rename docs/{Concepts => main/concepts}/discovery-and-bootstrap.md (100%) rename docs/{Concepts => main/concepts}/protocols-explained.md (100%) rename docs/{Concepts => main/concepts}/protocols-overview-by-example.md (100%) rename docs/{Concepts => main/concepts}/research-in-progress.md (100%) rename docs/{Concepts => main/concepts}/security-features.md (100%) rename docs/{Concepts => main/concepts}/transports-in-waku.md (100%) rename docs/{Concepts => main/concepts}/waku-vs-libp2p.md (100%) rename docs/{ => main}/history.md (100%) rename docs/{ => main}/how-does-it-work.md (100%) rename docs/{ => main}/implementations.md (100%) rename docs/{ => main}/introduction.md (100%) rename docs/{ => main}/motivation-and-goals.md (100%) rename docs/{ => main}/who-is-using-waku.md (100%) rename docs/{ => main}/why-waku.md (100%) diff --git a/docs/browser/introduction.md b/docs/browser/introduction.md new file mode 100644 index 0000000..2b15ebb --- /dev/null +++ b/docs/browser/introduction.md @@ -0,0 +1,5 @@ +--- +title: Introduction +--- + +js-waku doc goes here diff --git a/docs/Concepts/content-topics.md b/docs/main/concepts/content-topics.md similarity index 100% rename from docs/Concepts/content-topics.md rename to docs/main/concepts/content-topics.md diff --git a/docs/Concepts/different-protocols.md b/docs/main/concepts/different-protocols.md similarity index 100% rename from docs/Concepts/different-protocols.md rename to docs/main/concepts/different-protocols.md diff --git a/docs/Concepts/discovery-and-bootstrap.md b/docs/main/concepts/discovery-and-bootstrap.md similarity index 100% rename from docs/Concepts/discovery-and-bootstrap.md rename to docs/main/concepts/discovery-and-bootstrap.md diff --git a/docs/Concepts/protocols-explained.md b/docs/main/concepts/protocols-explained.md similarity index 100% rename from docs/Concepts/protocols-explained.md rename to docs/main/concepts/protocols-explained.md diff --git a/docs/Concepts/protocols-overview-by-example.md b/docs/main/concepts/protocols-overview-by-example.md similarity index 100% rename from docs/Concepts/protocols-overview-by-example.md rename to docs/main/concepts/protocols-overview-by-example.md diff --git a/docs/Concepts/research-in-progress.md b/docs/main/concepts/research-in-progress.md similarity index 100% rename from docs/Concepts/research-in-progress.md rename to docs/main/concepts/research-in-progress.md diff --git a/docs/Concepts/security-features.md b/docs/main/concepts/security-features.md similarity index 100% rename from docs/Concepts/security-features.md rename to docs/main/concepts/security-features.md diff --git a/docs/Concepts/transports-in-waku.md b/docs/main/concepts/transports-in-waku.md similarity index 100% rename from docs/Concepts/transports-in-waku.md rename to docs/main/concepts/transports-in-waku.md diff --git a/docs/Concepts/waku-vs-libp2p.md b/docs/main/concepts/waku-vs-libp2p.md similarity index 100% rename from docs/Concepts/waku-vs-libp2p.md rename to docs/main/concepts/waku-vs-libp2p.md diff --git a/docs/history.md b/docs/main/history.md similarity index 100% rename from docs/history.md rename to docs/main/history.md diff --git a/docs/how-does-it-work.md b/docs/main/how-does-it-work.md similarity index 100% rename from docs/how-does-it-work.md rename to docs/main/how-does-it-work.md diff --git a/docs/implementations.md b/docs/main/implementations.md similarity index 100% rename from docs/implementations.md rename to docs/main/implementations.md diff --git a/docs/introduction.md b/docs/main/introduction.md similarity index 100% rename from docs/introduction.md rename to docs/main/introduction.md diff --git a/docs/motivation-and-goals.md b/docs/main/motivation-and-goals.md similarity index 100% rename from docs/motivation-and-goals.md rename to docs/main/motivation-and-goals.md diff --git a/docs/who-is-using-waku.md b/docs/main/who-is-using-waku.md similarity index 100% rename from docs/who-is-using-waku.md rename to docs/main/who-is-using-waku.md diff --git a/docs/why-waku.md b/docs/main/why-waku.md similarity index 100% rename from docs/why-waku.md rename to docs/main/why-waku.md diff --git a/docusaurus.config.js b/docusaurus.config.js index f1fd39e..0feea09 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -49,9 +49,16 @@ const config = { title: "Waku", items: [ { - label: "Docs", - type: "doc", - docId: "introduction", + type: 'docSidebar', + position: 'left', + sidebarId: 'main', + label: 'Overview', + }, + { + type: 'docSidebar', + position: 'left', + sidebarId: 'browser', + label: 'JavaScript (Browser)', }, ], }, diff --git a/sidebars.js b/sidebars.js index 4a96ab2..b877d1f 100644 --- a/sidebars.js +++ b/sidebars.js @@ -3,32 +3,35 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { - docs: [ - "introduction", - "history", - "motivation-and-goals", - "why-waku", - "who-is-using-waku", - "implementations", - "how-does-it-work", + main: [ + "main/introduction", + "main/history", + "main/motivation-and-goals", + "main/why-waku", + "main/who-is-using-waku", + "main/implementations", + "main/how-does-it-work", { type: "category", label: "Concepts", collapsed: false, collapsible: true, items: [ - "Concepts/different-protocols", - "Concepts/protocols-explained", - "Concepts/protocols-overview-by-example", - "Concepts/discovery-and-bootstrap", - "Concepts/transports-in-waku", - "Concepts/content-topics", - "Concepts/security-features", - "Concepts/research-in-progress", - "Concepts/waku-vs-libp2p", + "main/concepts/different-protocols", + "main/concepts/protocols-explained", + "main/concepts/protocols-overview-by-example", + "main/concepts/discovery-and-bootstrap", + "main/concepts/transports-in-waku", + "main/concepts/content-topics", + "main/concepts/security-features", + "main/concepts/research-in-progress", + "main/concepts/waku-vs-libp2p", ], }, ], + browser: [ + "browser/introduction" + ] }; module.exports = sidebars; From a9ce323ab46ebba2eb649b41ac90c201369dc44a Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Tue, 21 Mar 2023 22:17:33 +1100 Subject: [PATCH 3/3] remove unnecessary comments --- docusaurus.config.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 0feea09..4d374cc 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -28,8 +28,6 @@ const config = { docs: { routeBasePath: "/", sidebarPath: require.resolve("./sidebars.js"), - // Please change this to your repo. - // Remove this to remove the "edit this page" links. editUrl: "https://github.com/waku-org/waku.guide/tree/staging/", }, theme: {