Skip to content

Commit f92fcfd

Browse files
authored
docs: overhaul (#225)
* new template * Create gh-pages.yml * update workflow * update workflow * remove links * add resources folder * update workflows * pinning details * update slug * new draft of storage section * update storage section and remove github folder * downgrade dependencies and install local search plugin * draft getting started, overview, and status pages * under construction notices added * utility classes section * remove example * consistency changes * intro section * remove missing utils * intros * emphasize under construction notices
1 parent dd6c300 commit f92fcfd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+8819
-16130
lines changed

.github/dependabot.yml

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

.github/workflows/check.yaml

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

.github/workflows/gh-pages.yaml

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

.github/workflows/release_github.yaml

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

.github/workflows/update-api-docs.yaml

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

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ node_modules
33
.DS_Store
44
build
55
public
6-
resources
76

87
# Local Netlify folder
98
.netlify
10-
11-
# Generated Bee API docs
12-
docs/api

.gitmodules

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

README.md

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,8 @@ Documentation for the [Swarm Bee-js javascript library](https://github.com/ether
44

55
### Node Version
66

7-
You must use **node 14** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).
7+
You must use **node 18** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).
88

9-
### Prerequisites
10-
11-
This project requires the bee-js repository to be cloned as a git submodule.
12-
13-
You can fetch it by cloning the entire repository with the following command:
14-
15-
```
16-
$ git clone --recurse-submodules https://github.com/ethersphere/bee-js.git
17-
```
18-
19-
Or optionally fetch the submodule after cloning with the following command:
20-
21-
```
22-
$ git submodule update --init
23-
```
249

2510
### Installation
2611

@@ -48,23 +33,6 @@ This command generates static content into the `build` directory and can be serv
4833

4934
Don't forget to find and replace the version number for the whole of the docs folder.
5035

51-
## How to generate / include the API reference html
52-
53-
```sh
54-
# Initialise the bee-js submodule
55-
git submodule update --init --recursive
56-
57-
# Update to the latest master, you could also change directory in and retrieve specific tag or branch
58-
git submodule update --remote --merge
59-
60-
# For the generation we need to have all the dependencies
61-
cd bee-js
62-
npm ci
63-
cd ..
64-
65-
# Generate new API
66-
npm run build
67-
```
6836

6937
## Maintainers
7038

bee-js

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

docs/documentation/act.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: ACT (Access Control Trie)
3+
id: act
4+
slug: /act
5+
sidebar_label: ACT
6+
---
7+
8+
## 🚧 Under Construction 🚧
9+
:::caution 🚧 This page is under construction
10+
11+
This section is still being worked on. Check back soon for updates!
12+
13+
:::
14+
15+
16+
* Show example of creating grantee list
17+
* Show example of secure upload
18+
* Show example of secure download

0 commit comments

Comments
 (0)