Documentation

Install and Run

# Install from script
curl -fsSL https://raw.githubusercontent.com/walkerbrown/goodwrite/main/scripts/install.sh | bash

# Check files, directories, or globs
goodwrite check docs/**/*.md docs/**/*.typ

# Apply machine-applicable fixes
goodwrite fix docs/manual.md

Optional Configuration

[profiles]
enable = ["asd-ste100", "ears", "glossary"]

[glossary]
path = "glossary.toml"

[unsafe]
ignore = ["docs/legacy/**/*.md"]

Requirement Syntax

<!-- goodwrite:requirement -->
The system shall reset in less than 100 ms.
<!-- goodwrite:requirement:end -->

<!-- goodwrite:requirement:state-driven -->
While battery voltage is below 22.0 V,
the system shall reduce transmit power.
<!-- goodwrite:requirement:end -->

#requirement[
The system shall reset in less than 100 ms.
]

#requirement_state[
While battery voltage is below 22.0 V,
  the system shall reduce transmit power.
]