{"id":19952904,"url":"https://github.com/ethersphere/swarm-documentation","last_synced_at":"2026-03-04T09:01:37.707Z","repository":{"id":78861774,"uuid":"507867249","full_name":"ethersphere/swarm-documentation","owner":"ethersphere","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-31T10:40:03.000Z","size":23165,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-08T18:50:40.177Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethersphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-27T10:42:49.000Z","updated_at":"2023-01-31T10:40:49.000Z","dependencies_parsed_at":"2024-03-09T04:15:33.007Z","dependency_job_id":null,"html_url":"https://github.com/ethersphere/swarm-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ethersphere/swarm-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethersphere","download_url":"https://codeload.github.com/ethersphere/swarm-documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethersphere%2Fswarm-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30076935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T08:01:56.766Z","status":"ssl_error","status_checked_at":"2026-03-04T08:00:42.919Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T01:14:44.010Z","updated_at":"2026-03-04T09:01:37.680Z","avatar_url":"https://github.com/ethersphere.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bee Documentation Website\n\nDocumentation for the [Swarm Bee Client](https://github.com/ethersphere/bee). View at [docs.ethswarm.org](https://docs.ethswarm.org).\n\n## Contributing\n\nPull Requests are welcome, but please read our [CODING](CODING.md) guide!\n\n### Node Version\n\nYou must use **node 14** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).\n\n### Installation\n\nAfter the initial cloning of the repo you need to run:\n\n```\nnpm ci\n```\n\nto download the exact revisions of the dependencies captured in\n`package-lock.json`.\n\nIf the dependencies are updated in `package.json`, or if you wish to\ntest with the latest revisions of the dependencies, then you should\nrun:\n\n```\nnpm install\n```\n\nand then consider pushing the updated `package-lock.json` to the\nrepository if everything works fine.\n\n### Local Development\n\n```\nnpm start\n```\n\nThis command starts a local development server and opens up a browser\nwindow. Most changes are reflected live without having to restart the\nserver.\n\n### Build\n\n```\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n## Bumping Version\n\nDon't forget to find and replace the version number for the whole of the docs folder. \n\n## How to generate / include the API reference html\n\n**NOTE: when this is done, the docs will have to be rebuilt.**\n\n1. 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).\n2. Generate the `index.html` file for the API docs via : `npx redoc-cli bundle Swarm.yaml -o ./SwarmAPIRedoc/index.html --disableGoogleFont --options.expandDefaultServerVariables \"true\"`\n3. Generate the `index.html` file for the Debug API via: `npx redoc-cli bundle SwarmDebug.yaml -o ./SwarmDebugAPIRedoc/index.html --disableGoogleFont --options.expandDefaultServerVariables \"true\"`\n4. Put the generated files into appropriate subfolders (`static/api/` and `static/debug-api/`)\n5. Rebuild and redeploy docs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fswarm-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethersphere%2Fswarm-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethersphere%2Fswarm-documentation/lists"}