acid-info
/
waku.guide
mirror of https://github.com/acid-info/waku.guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
30 Commits 11 Branches 0 Tags 2.1 MiB
JavaScript 57.5%
Python 26.9%
SCSS 15.1%
TypeScript 0.5%
Go to file
Danish Arora 4413612924
feat: improvements on docs (#24) 
* add: security features

* add: protocols overview by example

* add: different protocols

* add: spell check on CI

* rm: yarn.lock to avoid inconsistencies

* Update docs/Concepts/1.md

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

* Update docs/Concepts/2.md

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

* Update docs/Concepts/2.md

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

* Update docs/Concepts/7.md

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

* Update docs/Concepts/7.md

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

* convert mscgen sequence to mermaid

* partially adress review comments

* address: comments

* fix: ci

* chore: address minor typos/changes in docs

* add: pros/cons for discv5 and peer-exchange

* fix: minor typo

* chore: address refactoring

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>
 		2022-12-19 16:56:42 +05:30
.github/workflows feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
.vscode Squashed commit of the following: 2022-11-08 10:42:05 +11:00
docs feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
src/css add: prettier 2022-11-11 19:52:14 +05:30
static initial structure and testing 2022-08-17 22:26:08 +10:00
.cspell.json feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
.gitignore Squashed commit of the following: 2022-11-08 10:42:05 +11:00
.huskyrc add: prettier 2022-11-11 19:52:14 +05:30
.lintstagedrc add: prettier 2022-11-11 19:52:14 +05:30
.prettierignore add: prettier 2022-11-11 19:52:14 +05:30
README.md add: prettier 2022-11-11 19:52:14 +05:30
babel.config.js add: prettier 2022-11-11 19:52:14 +05:30
docusaurus.config.js feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
package-lock.json feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
package.json feat: improvements on docs (#24) 2022-12-19 16:56:42 +05:30
sidebars.js add: prettier 2022-11-11 19:52:14 +05:30
tsconfig.json initial structure and testing 2022-08-17 22:26:08 +10:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ 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 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, and all changes made to the Production Branch (usually "main" or "master") will result in a Production Deployment.