Replace checked-in PDF with AsciiDoc-formatted spec - Githubissues

sparcians / stf_spec

An open-source Simple Tracing Format specification

MIT License

9 stars 1 forks source link

Replace checked-in PDF with AsciiDoc-formatted spec #1

Closed bdutro closed 7 months ago

bdutro commented 7 months ago

This PR replaces the checked-in PDF with an AsciiDoc version to enable better collaboration. A few notes on how this implemented:

The files under the generated directory are generated by scripts and should not be edited directly
- In particular, generated/stf-spec-github.adoc is a flattened version of the documentation that renders properly on GitHub
Record definitions are kept in YAML files under the records directory