Documentation

The wasmCloud documentation site is hosted on GitHub and built with Docusarus.

Choosing a good first issue is a great way to get started.

Running the site locally

bash

npm run 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

bash

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service. It's a good idea build in order to check for errors like broken links that may prevent a successful deployment.

Serving static content

To serve the generated static content:

bash

npm run serve

Diagram assets

The official wasmCloud & Wasm Excalidraw library contains reusable components including wasmCloud cluster diagrams and architecture diagram elements.

Library URL: https://raw.githubusercontent.com/excalidraw/excalidraw-libraries/ricochet-wasmcloud-and-wasm-1770917744834/libraries/ricochet/wasmcloud-and-wasm.excalidrawlib?raw=true

Add to Excalidraw: Install Library

Additional image assets for diagrams are available in the community wasmCloud room on Excalidraw. Copy assets to your own Excalidraw session and export as PNG with a transparent background for compatibility with the site's dark and light modes.

We recommend copying assets that you would like to use to your own Excalidraw session and exporting your image as a PNG file with a transparent background (and careful use of black and white) for maximum compatibility with the documentation site's dark and light modes.

wasmCloud's brand colors are:

• Green Aqua - #00C389
• Light Gray - #768692
• Yellow - #FFB600
• Space Blue - #002E5D
• Gunmetal - #253746
• Gainsboro - #D9E1E2

Making a pull request

See the Pull Request section of the Contributing Guide. Note that a --signoff argument is required with your commits.