Files

Shahed Nasser c66e908099 docs: add upgrade guide for 1.3.8 (#2170 )

* add upgrade guide for 1.3.8

* added to sidebar

* added announcement bar

2022-09-09 13:26:19 +03:00

.yarn

chore(docs): Refactor API Reference (#1883 )

2022-08-05 14:06:12 +02:00

src

docs: fixes for sidebar on small devices (#2161 )

2022-09-07 19:46:15 +03:00

static

docs: restructured docs sidebar (#2156 )

2022-09-06 19:16:54 +03:00

.gitignore

chore: fix for deployment (#1970 )

2022-08-02 17:16:18 +03:00

babel.config.js

feat: Documentation and API reference (#348 )

2021-08-24 18:16:42 +02:00

docusaurus.config.js

docs: add upgrade guide for 1.3.8 (#2170 )

2022-09-09 13:26:19 +03:00

package.json

chore(docs): Refactor API Reference (#1883 )

2022-08-05 14:06:12 +02:00

README.md

docs: updated Docusaurus + fix recurring error (#1244 )

2022-04-08 11:16:22 +02:00

sidebars.js

docs: add upgrade guide for 1.3.8 (#2170 )

2022-09-09 13:26:19 +03:00

yarn.lock

chore(docs): Refactor API Reference (#1883 )

2022-08-05 14:06:12 +02:00

README.md

Website

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

Note Before Development

If you have installed the dependencies in the root of this repository (i.e., if you have a node_modules directory at the root of this repository), this will cause an error when running this documentation website. This is because the content resides in docs/content and when that content is being imported from there, a mix up can happen between the dependencies which will cause an invalid hook call error.

For that reason, we added a clean-node-modules script that deletes the node_modules directory, and we call that script before the start and build scripts are ran.

So, everytime you run these 2 scripts, the node_modules directory at the root will be deleted.