Skip to content

Commit 2bb9015

Browse files
authored
chore(docs): [DREL-220] Bump Docusaurus and TypeDoc (#2920)
## Summary Old docusaurus and its typescript version are blocking the upgrades of network team -> Killed the ailing docusaurus 2.x docs and re-created new docs with latest docusaurus 3.6.3. Docusaurus installation is kept as vanilla as possible. ## Changes - Docusaurus 2.x has been retired. - Custom scripts used in previous version to customize styles on API pages have been retired. ## Limitations and future improvements - Inject typedoc generated sidebar to docusaurus sidebar ts. - "Important classes" highlighed (i.e. @category Important in TypeDoc)? - Fixing Non-trailing slash redirects should now be easier in docusaurs 3.x
1 parent 4fbd2a1 commit 2bb9015

File tree

19 files changed

+17324
-14140
lines changed

19 files changed

+17324
-14140
lines changed

docs/.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
# Generated files
88
.docusaurus
99
.cache-loader
10-
/docs/usage/sdk/api
1110

1211
# Misc
1312
.DS_Store
@@ -20,3 +19,6 @@ npm-debug.log*
2019
yarn-debug.log*
2120
yarn-error.log*
2221
/.vscode
22+
23+
# Autogenerated API documentation
24+
/docs/usage/sdk/api

docs/.nvmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@ For ease of use, small changes can be suggested by editing the markdown file on
1010
### Run it locally
1111
Simply, `npm ci` & `npm start`
1212

13-
## Streamr core devs
14-
Deployments are automatically made after every commit to `main`, therefore editing markdown files directly on `main` will be reflected in production within a minute or two.
13+
### Create & serve production build locally
14+
Simply, `npm ci` & `npm run build` & `npm run serve`
15+
16+
### Clean & clear build folder
17+
Simply, `npm run clear`
18+

docs/babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/docusaurus.config.js

Lines changed: 0 additions & 198 deletions
This file was deleted.

0 commit comments

Comments
 (0)