diff --git a/docs/architect.md b/about/architect.md similarity index 98% rename from docs/architect.md rename to about/architect.md index 43ecff34..8844bf7b 100644 --- a/docs/architect.md +++ b/about/architect.md @@ -21,7 +21,7 @@ Waku was built as open-source public goods infrastructure to serve as the commun
-### Network architecture +## Network architecture The Waku team has developed three clients to run in different environments along with a range of SDKs in Rust, React Native, Kotlin and Swift: @@ -31,7 +31,7 @@ The Waku team has developed three clients to run in different environments along Waku is best thought of as a cohesive whole in terms of its capabilities. However, under the hood are three distinct network interaction domains: gossip, discovery and request/response. -#### Waku protocols +### Waku protocols Waku compromises multiple protocols, including but not limited to the following: diff --git a/docs/index.md b/about/index.md similarity index 97% rename from docs/index.md rename to about/index.md index 632ee6f9..cd84558f 100644 --- a/docs/index.md +++ b/about/index.md @@ -13,7 +13,7 @@ Yet, it doesn't have to be this way. Advances in cryptography, p2p technologies
-### (Slowly) moving toward a decentralized web +## (Slowly) moving toward a decentralized web The early Ethereum community realized this. Initially, the plan was to rebuild the web's architecture along decentralized lines by developing the so-called "Holy Trinity of the Decentralized Web." Ethereum itself would handle logic, Swarm was the reimagined web's storage layer and Whisper would take care of messaging. @@ -29,7 +29,7 @@ Status, the decentralized messaging application, hoped to leverage Whisper but w
-### The birth of Waku +## The birth of Waku In 2020, Waku v1 was released. A fork of the Whisper codebase, this initial version introduced various Vac-proposed optimizations, resulting in a more performant messaging protocol. Yet, it was clear that further changes were needed if Waku was to handle the volume of messages an application like Status would produce. diff --git a/docs/roadmap.md b/about/roadmap.md similarity index 96% rename from docs/roadmap.md rename to about/roadmap.md index 02257500..9d8df51a 100644 --- a/docs/roadmap.md +++ b/about/roadmap.md @@ -11,31 +11,31 @@ Meanwhile, the team is also working on ensuring production readiness alongside n
-#### Secure scalability +## Secure scalability Alongside Vac researchers, Waku is producing and implementing various RFCs to define the protocols and application guidelines required to serve more than one million simultaneous users. We then aim to study Waku's capacity through network simulations before designing and implementing scalability risk-mitigation strategies. -#### Production readines +## Production readines We will consider Waku v2 production ready when it's performant, stable and bug-free while satisfying user requirements. This process will involve collaboration with Status teams to test the protocols, and further simulations to assess future updates' expected performances. Ensuring that Waku has adequate protection against spam and DoS attacks is critically important to this milestone. -#### Network sustainability +## Network sustainability Many of Waku's core value propositions—privacy and resistance to censorship, for example—are reliant on its decentralization. While our most passionate users may well operate network infrastructure altruistically, incentivization mechanisms will ensure a wider node distribution and, thus, strengthen Waku's more disruptive properties. This process will involve defining a viable incentivization structure via RFC and studying its efficacy to tweak parameters through test net simulations before implementation on the main net. -#### Development sustainability +## Development sustainability We believe Waku will only realize its true potential if its community and users believe in its longevity. As such, Waku's development must remain funded. Again, arriving at a suitable funding mechanism will involve several RFCs to define how much of the network's extractable value can be diverted toward R&D efforts. -#### Growth +## Growth After achieving the above milestones, we will be in a position to aggressively market Waku to potential contributors and developers within the web3 sector and beyond. As a piece of public goods infrastructure, we encourage the wider community to help improve the protocols by contributing to our R&D efforts. However, promotion is an ongoing process that is already underway, involving conference attendance and sponsorship, hosting developer workshops, producing promotional material, and appearing on industry-focused podcasts.
-### Roadmap rationale +## Roadmap rationale Completing the roadmap objectives described above will best position Waku for maximum user adoption. Proving Waku is scalable and reliable must come before subsequent milestones as the network's non-functionality will discourage infrastructure operators regardless of the incentive structure we put in place. diff --git a/docs/team.md b/about/team.md similarity index 96% rename from docs/team.md rename to about/team.md index 87bce62c..5d0e347c 100644 --- a/docs/team.md +++ b/about/team.md @@ -7,11 +7,11 @@ Leading Waku's R&D efforts is Franck Royer. Royer draws on more than five years The core contributors building Waku are split into three subgroups: -#### Waku Research +## Waku Research Our research efforts are led by a former telecoms engineer with almost a decade of experience, and supported by a post-doctoral research engineer who specializes in communications networks. -#### Waku Development +## Waku Development Waku's development arm is broken down by client implementation. @@ -21,7 +21,7 @@ Waku's development arm is broken down by client implementation. - go-waku: Building Waku's Golang implementation is a senior software engineer with almost 15 years of experience, including five in web3. -#### Waku Outreach +## Waku Outreach Ensuring that Waku attracts developers and users is the Waku Outreach team. It comprises a developer relations engineer and a technical writer. Both members are steeped in web3, having previously worked with Wallet Connect and Unstoppable Domains, and regularly presenting on the crypto conference circuit. diff --git a/docusaurus.config.js b/docusaurus.config.js index 509f8835..c7784f46 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,9 +8,6 @@ const config = { url: 'https://url', baseUrl: '/', - customFields: { - ghostAPiKey: process.env.GHOST_API_KEY, - }, markdown: { mermaid: true, }, @@ -33,22 +30,35 @@ const config = { name: 'default', options: { customCss: [require.resolve('./src/css/custom.scss')], + docs: { + default: { + sidebar: { + hide: true, + }, + }, + }, }, }, docs: { - routeBasePath: '/about', - versions: { - current: { - label: 'current', - }, - }, - lastVersion: 'current', + routeBasePath: '/', + path: 'root-pages', }, }), ], ], themes: ['@docusaurus/theme-mermaid'], + plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + id: 'about', + routeBasePath: '/about', + path: 'about', + }, + ], + ], + themeConfig: /** @type {import('@acid-info/logos-docusaurus-preset').ThemeConfig} */ ({ @@ -57,6 +67,7 @@ const config = { disableSwitch: false, }, navbar: { + hideOnScroll: true, items: [ { type: 'search', @@ -113,7 +124,7 @@ const config = { label: 'Privacy policy', }, { - href: '/', + href: '/terms', label: 'Temrs & conditions', }, ], diff --git a/package.json b/package.json index b1bd4bef..32282700 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "typecheck": "tsc" }, "dependencies": { - "@acid-info/logos-docusaurus-preset": "^1.0.0-alpha.4", + "@acid-info/logos-docusaurus-preset": "^1.0.0-alpha.5", "@docusaurus/core": "2.4.1", "@docusaurus/preset-classic": "2.4.1", "@docusaurus/theme-mermaid": "^2.4.1", diff --git a/root-pages/terms.md b/root-pages/terms.md new file mode 100644 index 00000000..e88bd5c9 --- /dev/null +++ b/root-pages/terms.md @@ -0,0 +1,67 @@ +# Terms of Use + +These terms and conditions (“**Website Terms of Use**”) are entered into by you and us, and they govern your access and use of the Website, including any content and functionality contained in the Website.  + +It is your responsibility to read the Website Terms of Use carefully before your use of the Website and your use of the Website means you have agreed to be bound and comply with these Website Terms of Use.  + +If you do not agree with these Website Terms of Use, you must not access or use the Website.  + +### Content provided for informational purposes only + +Content available on the Website is for informational purposes only and is not intended to address the specific circumstances of any particular individual or entity. Such content may not always be entirely accurate, complete, or up to date and may also include inaccuracies or typographical errors. You are solely responsible for verifying their adequacy, completeness and accuracy and any reliance you place on such content is at your own risk.  + +None of the content on this Website should be considered by you as legal, tax, investment, financial, professional or any other type of advice. You should always conduct your own research and seek independent professional advice if necessary. You are solely responsible for the decisions or actions you might take in this respect. We are not liable for any loss resulting from your action (or inaction) and decisions based on this content on this Website.  + +Additionally, we are not responsible for any information, content, or services contained in any third-party content or on any third-party websites accessible or linked through this website.  + +### Intellectual property rights + +The Website and its contents are made available under free and open source licences. This means that anyone can use, share, and modify such content, as long as they follow the terms of the applicable licence.  + +### Third party website links + +To the extent the Website provides any links to a third party website, then their terms and conditions, including privacy policies, govern your use of those third party websites. We have no control over such third party websites and will not be liable for your use of or activities on any third party websites accessed through the Website. If you access such third party websites through the Website, it is at your own risk and you are solely responsible for your activities on such third party websites. + +### Disclaimer + +The Website is provided by us on an ‘as is’ basis and you use the Website at your own sole discretion and risk. + +We disclaims all warranties of any kind, express or implied, including without limitation the warranties of merchantability, fitness for a particular purpose, and non-infringement of intellectual property or other violation of rights. We do not warrant or make any representations concerning the completeness, accuracy, legality, utility, reliability, suitability or availability of the use of the Website, the content on this Website or otherwise relating to the Website, such content or on any sites linked to this site. + +We make no claims that the Website or any of its content is accessible, legally compliant or appropriate in your jurisdiction. Your access or use of the Website is at your own sole discretion and you are solely responsible for complying with any applicable local laws. These disclaimers will apply to the maximum extent permitted by applicable law.  + +### Limitation of liability + +We will not be held liable to you under any contract, negligence, strict liability, or other legal or equitable theory for any lost profits, cost of procurement for substitute services, or any special, incidental, or consequential damages related to, arising from, or in any way connected with these Website Terms of Use, the Website, the content on the Website, or your use of the Website, even if we have been advised of the possibility of such damages. In any event, our aggregate liability for such claims is limited to EUR 100 (one hundred Euros). This limitation of liability will apply to the maximum extent permitted by applicable law. + +### Indemnity + +You shall indemnify us and hold us harmless from and against any and all claims, damages and expenses, including attorneys’ fees, arising from or related to your use of the Website, the content on the Website, including without limitation your violation of these Website Terms of Use.  + +### Modifications + +We may modify or replace any part of this Website Terms of Use at any time and without notice. You are responsible for checking the Website periodically for any changes. The new Website Terms of Use will be effective immediately upon its posting on the Website. + +### Governing law + +Swiss law governs these Website Terms of Use and any disputes between you and us, whether in court or arbitration, without regard to conflict of laws provisions. + +### Disputes + +In these terms, “dispute” has the broadest meaning enforceable by law and includes any claim you make against or controversy you may have in relation to these Website Terms of Use, the Website, the content on the Website, or your use of the Website  + +We prefer arbitration over litigation as we believe it meets our principle of resolving disputes in the most effective and cost effective manner. You are bound by the following arbitration clause, which waives your right to litigation and to be heard by a judge. Please note that court review of an arbitration award is limited. You also waive all your rights to a jury trial (if any) in any and all jurisdictions.  + +If a (potential) dispute arises, you must first use your reasonable efforts to resolve it amicably with us. If these efforts do not result in a resolution of such dispute, you shall then send us a written notice of dispute setting out (i) the nature of the dispute, and the claim you are making; and (ii) the remedy you are seeking.  + +If we and you are unable to further resolve this dispute within sixty (60) calendar days of us receiving this notice of dispute, then any such dispute will be referred to and finally resolved by you and us through an arbitration administered by the Swiss Chambers’ Arbitration Institution in accordance with the Swiss Rules of International Arbitration for the time being in force, which rules are deemed to be incorporated herein by reference. The arbitral decision may be enforced in any court. The arbitration will be held in Zug, Switzerland, and may be conducted via video conference virtual/online methods if possible. The tribunal will consist of one arbitrator, and all proceedings as well as communications between the parties will be kept confidential. The language of the arbitration will be in English. Payment of all relevant fees in respect of the arbitration, including filing, administration and arbitrator fees will be in accordance with the Swiss Rules of International Arbitration.  + +Regardless of any applicable statute of limitations, you must bring any claims within one year after the claim arose or the time when you should have reasonably known about the claim. You also waive the right to participate in a class action lawsuit or a classwide arbitration against us.  + +### About these Website Terms of Use + +These Website Terms of Use cover the entire agreement between you and us regarding the Website and supersede all prior and contemporaneous understandings, agreements, representations and warranties, both written and oral, with respect to the Website.  + +The captions and headings identifying sections and subsections of these Website Terms of Use are for reference only and do not define, modify, expand, limit, or affect the interpretation of any provisions of these Website Terms of Use.  + +If any part of these Website Terms of Use is held invalid or unenforceable, that part will be severable from these Website Terms of Use, and the remaining portions will remain in full force and effect. If we fail to enforce any of these Website Terms of Use, that does not mean that we have waived our right to enforce them. diff --git a/src/pages/index.mdx b/src/pages/index.mdx index 64a498bc..7f3cbddd 100644 --- a/src/pages/index.mdx +++ b/src/pages/index.mdx @@ -5,21 +5,25 @@ import { HeroActions, HeroAction, CallToActionSection, + CallToActionButton, FeatureList, Showcase, HeroModel, + HeroInfo, + Box, } from '../components/mdx' - The web3 managing standard + The web3 managing standard. {/* - - Waku is a decentralized communications network that enables private, censorship-resistant messaging for web3 applications. - - * */} + + Waku is a decentralized communications network that enables private, censorship-resistant messaging for web3 + applications. + + * */} - WAKU IS A DECENTRALIZED COMMUNICATIONS NETWORK. + Waku is a decentralized communications network @@ -31,14 +35,11 @@ import { @@ -67,41 +68,77 @@ import { "Waku's native incentivization mechanisms ensure a wide node distribution, making it highly secure and strengthening its privacy assurances.", }, ]} -/> +> + + Decentralize your DApp + + - + + + - + + + - + + + + + + + + + + + diff --git a/src/pages/test.mdx b/src/pages/test.mdx deleted file mode 100644 index 8954bb97..00000000 --- a/src/pages/test.mdx +++ /dev/null @@ -1 +0,0 @@ -# hello diff --git a/static/hero/architecture01/hi.glb b/static/hero/architecture01/hi.glb new file mode 100644 index 00000000..b07454d1 Binary files /dev/null and b/static/hero/architecture01/hi.glb differ diff --git a/static/hero/architecture01/lo.glb b/static/hero/architecture01/lo.glb new file mode 100644 index 00000000..b07454d1 Binary files /dev/null and b/static/hero/architecture01/lo.glb differ diff --git a/static/hero/bulanding-generic-atlas-01.glb b/static/hero/bulanding-generic-atlas-01.glb deleted file mode 100644 index 0adfed0c..00000000 Binary files a/static/hero/bulanding-generic-atlas-01.glb and /dev/null differ diff --git a/static/hero/bulanding-generic-hand-01.glb b/static/hero/bulanding-generic-hand-01.glb deleted file mode 100644 index 5492ee5e..00000000 Binary files a/static/hero/bulanding-generic-hand-01.glb and /dev/null differ diff --git a/static/hero/bulanding-generic-vase-02.glb b/static/hero/bulanding-generic-vase-02.glb deleted file mode 100644 index 30f50f03..00000000 Binary files a/static/hero/bulanding-generic-vase-02.glb and /dev/null differ diff --git a/static/hero/bust-hi.glb b/static/hero/default/hi.glb similarity index 100% rename from static/hero/bust-hi.glb rename to static/hero/default/hi.glb diff --git a/static/hero/bust-lo-draco.glb b/static/hero/default/lo.glb similarity index 100% rename from static/hero/bust-lo-draco.glb rename to static/hero/default/lo.glb diff --git a/static/showcase/the-graph-mark-white.svg b/static/showcase/the-graph-mark-white.svg new file mode 100644 index 00000000..b742361c --- /dev/null +++ b/static/showcase/the-graph-mark-white.svg @@ -0,0 +1,3 @@ + + + diff --git a/yarn.lock b/yarn.lock index 82b546d1..b2b817d4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2,13 +2,13 @@ # yarn lockfile v1 -"@acid-info/logos-docusaurus-preset@^1.0.0-alpha.4": - version "1.0.0-alpha.4" - resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-preset/-/logos-docusaurus-preset-1.0.0-alpha.4.tgz#ec958cc49d0420bc361541002138dc0bd8595889" - integrity sha512-kVOaa0bCPy5tBJxEZS51N3+UgtO6M4TciRA7x/4JQ+uwy1s5cSldkecmjmb1Ch5/tGB6QCllU2tjuZrsY1aiRg== +"@acid-info/logos-docusaurus-preset@^1.0.0-alpha.5": + version "1.0.0-alpha.5" + resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-preset/-/logos-docusaurus-preset-1.0.0-alpha.5.tgz#5c2c0c5e853ac5fd7bcd60f4cfd5fbe32dca23a9" + integrity sha512-4QMlEhxByT7QXI33mFJoEkaxbS5XOnTbYZWna6WrnZGQf7P9SkrMKMY5r7sxWevJyDDrj9VAz/XkLgzCjGYvzg== dependencies: "@acid-info/logos-docusaurus-search-local" "^1.0.0-alpha.0" - "@acid-info/logos-docusaurus-theme" "^1.0.0-alpha.4" + "@acid-info/logos-docusaurus-theme" "^1.0.0-alpha.5" "@docusaurus/core" "^2.4.1" "@docusaurus/module-type-aliases" "^2.4.1" "@docusaurus/preset-classic" "^2.4.1" @@ -34,12 +34,12 @@ "@easyops-cn/docusaurus-search-local" "^0.33.6" lodash "^4.17.21" -"@acid-info/logos-docusaurus-theme@^1.0.0-alpha.4": - version "1.0.0-alpha.4" - resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-theme/-/logos-docusaurus-theme-1.0.0-alpha.4.tgz#63ef02dc4f9acc816bc9bdb7fb5a4664c0a5a3ee" - integrity sha512-mQBaIUVVe2LWnKHFfeCnMtLkbCbJxe306DrO+Q2v4f4VXkDiTygXDCd8Rs/DFCPhlyIDRkZRfgH4Fzmb1S+lwA== +"@acid-info/logos-docusaurus-theme@^1.0.0-alpha.5": + version "1.0.0-alpha.5" + resolved "https://registry.yarnpkg.com/@acid-info/logos-docusaurus-theme/-/logos-docusaurus-theme-1.0.0-alpha.5.tgz#608bb4130baaabeb472278fb4737af58f44d1c3d" + integrity sha512-GQjuk03skPsdKyQYKt27OfuD5BcpTZxOQ8HMLwsUNWsLwEcHuVgCKJbb5UCom2yL3Fek0Qp6egf7AKR5w8xZ3g== dependencies: - "@acid-info/logos-docusaurus-preset" "^1.0.0-alpha.4" + "@acid-info/logos-docusaurus-preset" "^1.0.0-alpha.5" "@acid-info/lsd-react" "^0.1.0-alpha.8" "@docusaurus/core" "^2.4.1" "@docusaurus/mdx-loader" "^2.4.1"