add: prettier & write files

Signed-off-by: danisharora099 <danisharora099@gmail.com>
This commit is contained in:
danisharora099 2022-11-10 20:49:34 +05:30
parent 63304a2722
commit a474cd39ec
No known key found for this signature in database
GPG Key ID: FBD2BF500037F135
10 changed files with 42 additions and 31 deletions

6
.prettierrc Normal file
View File

@ -0,0 +1,6 @@
{
"semi": true,
"trailingComma": "none",
"singleQuote": false,
"printWidth": 80
}

View File

@ -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. This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment ### 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. 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). 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). 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).

View File

@ -1,3 +1,3 @@
module.exports = { module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], presets: [require.resolve("@docusaurus/core/lib/babel/preset")]
}; };

View File

@ -24,7 +24,7 @@ It is the communication layer for Web3 -- **decentralized communication that sca
Private. Secure. Runs anywhere. Private. Secure. Runs anywhere.
| | Whisper | Waku | | | Whisper | Waku |
|----------------------------------------| ------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------: | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------: |
| **Scalability** | Whisper doesn't scale very well, specifically when it comes to bandwidth usage on mobile devices. | Uses gossipsub and content topics. | | **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 | | **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. | | **No incentivized infrastructure** | There is no incentive to run a Whisper node | Research in progress to design incentivization for node operators. |

View File

@ -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 4. Economic **spam protection** (rate limit) with privacy preserving capabilities
5. Mass deanonymization protection (research in progress) 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. If you want to learn how Waku works under the hoods, check out the [10/WAKU2](https://rfc.vac.dev/spec/10/) RFC.

View File

@ -24,7 +24,7 @@ const config = {
// to replace "en" with "zh-Hans". // to replace "en" with "zh-Hans".
i18n: { i18n: {
defaultLocale: "en", defaultLocale: "en",
locales: ["en"], locales: ["en"]
}, },
presets: [ presets: [
@ -33,30 +33,29 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */ /** @type {import('@docusaurus/preset-classic').Options} */
({ ({
docs: { docs: {
routeBasePath: '/', routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"), sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo. // Please change this to your repo.
// Remove this to remove the "edit this page" links. // Remove this to remove the "edit this page" links.
editUrl: editUrl: "https://github.com/waku-org/waku.guide/tree/staging/"
"https://github.com/waku-org/waku.guide/tree/staging/",
}, },
theme: { theme: {
customCss: require.resolve("./src/css/custom.css"), customCss: require.resolve("./src/css/custom.css")
}, }
}), })
], ]
], ],
themeConfig: { themeConfig: {
colorMode: { colorMode: {
defaultMode: "dark", defaultMode: "dark",
disableSwitch: false, disableSwitch: false,
respectPrefersColorScheme: true, respectPrefersColorScheme: true
}, },
navbar: { navbar: {
title: "Waku", title: "Waku",
logo: { logo: {
alt: "Waku Logo", alt: "Waku Logo",
src: "img/logo.svg", src: "img/logo.svg"
}, },
items: [ items: [
@ -64,9 +63,9 @@ const config = {
type: "doc", type: "doc",
docId: "Concepts/1", docId: "Concepts/1",
position: "left", position: "left",
label: "Concepts", label: "Concepts"
}, }
], ]
}, },
footer: { footer: {
style: "dark", style: "dark",
@ -76,26 +75,26 @@ const config = {
items: [ items: [
{ {
label: "Discourse", label: "Discourse",
href: "https://forum.vac.dev/", href: "https://forum.vac.dev/"
}, },
{ {
label: "Discord", label: "Discord",
href: "https://discord.gg/j5pGbn7MHZ", href: "https://discord.gg/j5pGbn7MHZ"
}, },
{ {
label: "Twitter", 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: { prism: {
theme: lightCodeTheme, theme: lightCodeTheme,
darkTheme: darkCodeTheme, darkTheme: darkCodeTheme
}, }
}, }
}; };
module.exports = config; module.exports = config;

View File

@ -26,6 +26,7 @@
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "2.0.1", "@docusaurus/module-type-aliases": "2.0.1",
"@tsconfig/docusaurus": "^1.0.5", "@tsconfig/docusaurus": "^1.0.5",
"prettier": "^2.7.1",
"typescript": "^4.7.4" "typescript": "^4.7.4"
}, },
"browserslist": { "browserslist": {

View File

@ -13,7 +13,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = { const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure // 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 // But you can create a sidebar manually
/* /*
tutorialSidebar: [ tutorialSidebar: [

View File

@ -23,7 +23,7 @@
/*--ifm-font-size-base: 90%;*/ /*--ifm-font-size-base: 90%;*/
} }
[data-theme='dark'] { [data-theme="dark"] {
--ifm-color-primary: #f3ddc3; --ifm-color-primary: #f3ddc3;
--ifm-color-primary-dark: #ecc89e; --ifm-color-primary-dark: #ecc89e;
--ifm-color-primary-darker: #e8be8c; --ifm-color-primary-darker: #e8be8c;
@ -36,6 +36,6 @@
--ifm-heading-color: #faf2e8; --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;*/ /*border: none !important;*/
} }

View File

@ -5730,6 +5730,11 @@ prepend-http@^2.0.0:
resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897" resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897"
integrity sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA== 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: pretty-error@^4.0.0:
version "4.0.0" version "4.0.0"
resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6" resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6"