srivatsanhari / bee-docs

Documentation for the Swarm Bee Client. View at docs.ethswarm.org, contributions welcome!

Bee Documentation Website

Documentation for the Swarm Bee Client. View at docs.ethswarm.org.

Contributing

Pull Requests are welcome, but please read our CODING guide!

Node Version

You must use node 14 or above. We recommend nvm.

Installation

After the initial cloning of the repo you need to run:

npm ci

to download the exact revisions of the dependencies captured in package-lock.json.

If the dependencies are updated in package.json, or if you wish to test with the latest revisions of the dependencies, then you should run:

npm install

and then consider pushing the updated package-lock.json to the repository if everything works fine.

Local Development

npm 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

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Bumping Version

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

How to generate / include the API reference html

NOTE: when this is done, the docs will have to be rebuilt.

1. Get the OpenAPI YAML source files from which the documentation is generated. They can be found in the openapi folder of bee repo.
2. Generate the index.html file for the API docs via : npx redoc-cli bundle Swarm.yaml -o ./SwarmAPIRedoc/index.html --disableGoogleFont --options.expandDefaultServerVariables "true"
3. Generate the index.html file for the Debug API via: npx redoc-cli bundle SwarmDebug.yaml -o ./SwarmDebugAPIRedoc/index.html --disableGoogleFont --options.expandDefaultServerVariables "true"
4. Put the generated files into appropriate subfolders (static/api/ and static/debug-api/)
5. Rebuild and redeploy docs.