README.md

Smithy Docs

This website is built using Docusaurus, a modern static website generator.

Installation

yarn install

Local Development

yarn 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.

Deployment

The docs are automatically deployed to GitHub pages, hosted at docs.smithy.security. More information can be found in the .github/workflows/ folder.

Writing

We follow Diátaxis, a systematic approach to technical documentation authoring.