diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..bfbe54b --- /dev/null +++ b/.prettierrc @@ -0,0 +1,6 @@ +{ + "semi": true, + "trailingComma": "none", + "singleQuote": false, + "printWidth": 80 +} diff --git a/README.md b/README.md index 664c35f..9445e4e 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment + For our current stage, we use Vercel for Deployment and hosting. [Vercel](https://vercel.com/about) provides us with various benefits in the areas of performance and ease of use that is great for our initial stage. Each project first needs to be defined & imported to Vercel (for this you can always contact Comms people). -After your project has been imported, all subsequent pushes to branches will generate [Preview Deployments](https://vercel.com/docs/concepts/deployments/environments#preview), and all changes made to the [Production Branch](https://vercel.com/docs/concepts/git#production-branch) (usually "main" or "master") will result in a [Production Deployment](https://vercel.com/docs/concepts/deployments/environments#production). \ No newline at end of file +After your project has been imported, all subsequent pushes to branches will generate [Preview Deployments](https://vercel.com/docs/concepts/deployments/environments#preview), and all changes made to the [Production Branch](https://vercel.com/docs/concepts/git#production-branch) (usually "main" or "master") will result in a [Production Deployment](https://vercel.com/docs/concepts/deployments/environments#production). diff --git a/babel.config.js b/babel.config.js index e00595d..df99bdb 100644 --- a/babel.config.js +++ b/babel.config.js @@ -1,3 +1,3 @@ module.exports = { - presets: [require.resolve('@docusaurus/core/lib/babel/preset')], + presets: [require.resolve("@docusaurus/core/lib/babel/preset")] }; diff --git a/docs/4.md b/docs/4.md index 18bc224..56074ca 100644 --- a/docs/4.md +++ b/docs/4.md @@ -24,7 +24,7 @@ It is the communication layer for Web3 -- **decentralized communication that sca Private. Secure. Runs anywhere. | | Whisper | Waku | -|----------------------------------------| ------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------: | +| -------------------------------------- | ------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------: | | **Scalability** | Whisper doesn't scale very well, specifically when it comes to bandwidth usage on mobile devices. | Uses gossipsub and content topics. | | **Spam Resistance** | Proof of work requires too much battery and compute power making it a poor mechanism for heterogeneous nodes. | Uses innovative p2p economic spam protection mechanism RLN Relay | | **No incentivized infrastructure** | There is no incentive to run a Whisper node | Research in progress to design incentivization for node operators. | diff --git a/docs/7.md b/docs/7.md index e0a4d1b..c66ca98 100644 --- a/docs/7.md +++ b/docs/7.md @@ -12,5 +12,4 @@ Other Waku protocols have been defined to enable capabilities such as: 4. Economic **spam protection** (rate limit) with privacy preserving capabilities 5. Mass deanonymization protection (research in progress) - If you want to learn how Waku works under the hoods, check out the [10/WAKU2](https://rfc.vac.dev/spec/10/) RFC. diff --git a/docusaurus.config.js b/docusaurus.config.js index 0fca86c..e2041bd 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -24,7 +24,7 @@ const config = { // to replace "en" with "zh-Hans". i18n: { defaultLocale: "en", - locales: ["en"], + locales: ["en"] }, presets: [ @@ -33,30 +33,29 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - routeBasePath: '/', + 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/", + editUrl: "https://github.com/waku-org/waku.guide/tree/staging/" }, theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - }), - ], + customCss: require.resolve("./src/css/custom.css") + } + }) + ] ], themeConfig: { colorMode: { defaultMode: "dark", disableSwitch: false, - respectPrefersColorScheme: true, + respectPrefersColorScheme: true }, navbar: { title: "Waku", logo: { alt: "Waku Logo", - src: "img/logo.svg", + src: "img/logo.svg" }, items: [ @@ -64,9 +63,9 @@ const config = { type: "doc", docId: "Concepts/1", position: "left", - label: "Concepts", - }, - ], + label: "Concepts" + } + ] }, footer: { style: "dark", @@ -76,26 +75,26 @@ const config = { items: [ { label: "Discourse", - href: "https://forum.vac.dev/", + href: "https://forum.vac.dev/" }, { label: "Discord", - href: "https://discord.gg/j5pGbn7MHZ", + href: "https://discord.gg/j5pGbn7MHZ" }, { label: "Twitter", - href: "https://twitter.com/waku-org", - }, - ], - }, + href: "https://twitter.com/waku-org" + } + ] + } ], - copyright: `Copyright © ${new Date().getFullYear()} Status Gmbh. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} Status Gmbh. Built with Docusaurus.` }, prism: { theme: lightCodeTheme, - darkTheme: darkCodeTheme, - }, - }, + darkTheme: darkCodeTheme + } + } }; module.exports = config; diff --git a/package.json b/package.json index 6c315fd..12da244 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,7 @@ "devDependencies": { "@docusaurus/module-type-aliases": "2.0.1", "@tsconfig/docusaurus": "^1.0.5", + "prettier": "^2.7.1", "typescript": "^4.7.4" }, "browserslist": { diff --git a/sidebars.js b/sidebars.js index 8769682..28cb924 100644 --- a/sidebars.js +++ b/sidebars.js @@ -13,7 +13,7 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + tutorialSidebar: [{ type: "autogenerated", dirName: "." }] // But you can create a sidebar manually /* tutorialSidebar: [ diff --git a/src/css/custom.css b/src/css/custom.css index eff4882..1638205 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -23,7 +23,7 @@ /*--ifm-font-size-base: 90%;*/ } -[data-theme='dark'] { +[data-theme="dark"] { --ifm-color-primary: #f3ddc3; --ifm-color-primary-dark: #ecc89e; --ifm-color-primary-darker: #e8be8c; @@ -36,6 +36,6 @@ --ifm-heading-color: #faf2e8; } -.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-theme-DocPage-Layout-Sidebar-styles-module{ +.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-theme-DocPage-Layout-Sidebar-styles-module { /*border: none !important;*/ -} \ No newline at end of file +} diff --git a/yarn.lock b/yarn.lock index 8721016..03067d2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5730,6 +5730,11 @@ prepend-http@^2.0.0: resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897" integrity sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA== +prettier@^2.7.1: + version "2.7.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.7.1.tgz#e235806850d057f97bb08368a4f7d899f7760c64" + integrity sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g== + pretty-error@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6"