22 lines (13 loc) · 844 Bytes

Bee-JS Docs (Ethereum Swarm)

This repository holds the source code for the Bee-JS documentation, which is hosted at https://bee-js.ethswarm.org/.
Bee-JS (@ethersphere/bee-js) is the official TypeScript library for interacting with a Bee node.

Layout

The documentation site is built using Docusaurus.

Always do this first

git clone https://github.com/ethersphere/bee-js and https://github.com/ethersphere/core-sdk into sources/ so they are available for quick access. If they are already cloned, pull the latest changes.

Writing style

Refer to TROPES.md for writing style guidelines.

Rules

Never commit or push.
Never review your changes in the browser, tell the user instead to check the local build.
Always ask the user if something is ambiguous or unclear. Do not assume anything.