https://github.com/ethersphere/swarm-documentation
https://github.com/ethersphere/swarm-documentation
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ethersphere/swarm-documentation
- Owner: ethersphere
- Created: 2022-06-27T10:42:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T10:40:03.000Z (over 3 years ago)
- Last Synced: 2025-04-08T18:50:40.177Z (about 1 year ago)
- Language: HTML
- Size: 22.1 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bee Documentation Website
Documentation for the [Swarm Bee Client](https://github.com/ethersphere/bee). View at [docs.ethswarm.org](https://docs.ethswarm.org).
## Contributing
Pull Requests are welcome, but please read our [CODING](CODING.md) guide!
### Node Version
You must use **node 14** or above. We recommend [nvm](https://github.com/nvm-sh/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](https://github.com/ethersphere/bee/tree/master/openapi).
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.