bee-js Documentation Website

Documentation for the Swarm Bee-js javascript library. View at bee-js.ethswarm.org.

Node Version

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

Installation

$ npm i

Local Development

$ npm start

This command starts a local development server and open 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.

Maintainers

See what "Maintainer" means here.

LLM-Friendly Documentation (llms.txt)

The site serves two files for AI agents at the root:

• /llms.txt — Hand-crafted index file (static/llms.txt). A curated list of every documentation page with one-line descriptions. This is the entry point AI agents use to find relevant pages.
• /llms-full.txt — Auto-generated by docusaurus-plugin-llms at build time. Contains the full text of every page concatenated into a single file.

Keeping llms.txt up to date

The validation script scripts/validate-llms-txt.mjs runs automatically during npm run build (via the prebuild hook). It cross-checks static/llms.txt against the actual doc files and prints warnings for:

• Stale links — a URL in llms.txt points to a doc page that no longer exists (renamed/deleted).
• Missing coverage — a doc file exists that isn't listed in llms.txt (new page added without updating the index).

The script is informational only (exit 0) — it won't block the build.

What to do when warnings appear

1. Stale link: Open static/llms.txt, find the flagged URL, and either update the path to match the renamed page or remove the entry if the page was deleted.
2. Missing coverage: Decide which section the new page belongs in and add a line in static/llms.txt following the existing format: - [Title](https://bee-js.ethswarm.org/docs/path): One-line description.