Documentation

Broadside is in preview: 0.1.0-preview.1 is on NuGet.org, and the public API may still change before v1. These pages say how to start using it, how it is designed, what is implemented, and how to follow or join the work.

  • Getting started: installation, a first example, the viewers and the samples.
  • Architecture: the terms used throughout the code and the architecture decision records.
  • Roadmap: the phases and their status, what is unreleased, and the known issues.
  • Conformance: the per-clause record of what is implemented.
  • Contributing: the issue, branch and pull request flow.
  • API coverage: which target framework each package's API reference is built from, and the API of the one package it cannot build.

The API reference is generated from the XML documentation of every package on every build of this site.