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 9ae8566..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: { @@ -49,9 +47,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)', }, ], }, @@ -60,22 +65,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", + }, ], }, ], 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;