Bug32619: fix syntax errors in torspec documents #95

eighthave · 2019-11-26T21:58:06Z

This fixes a handful of errors in the syntax of things like the title line and the section names. That makes these files much more machine readable. All of the changes here are trivial.

With these changes, then a script can convert these files to a nice collection of HTML pages in a CI job that takes less than a minute to run:

This provides nice features like links to sections based on the section name:

Using GitLab CI, this could easily rsync the result to any webserver.

This is one small step towards making these a standard, parsable format.

The clear standard is trailing "." after each numeric section. This fixes the small handful of outliers. This makes it easy to convert these headers to common markup formats, for example: http://hyperpolyglot.org/lightweight-markup

eighthave added 3 commits Nov 26, 2019

standardize whitespace in the titles

c15cc8a

This is one small step towards making these a standard, parsable format.

fix erroneous header numbering punctuation

a3fd193

The clear standard is trailing "." after each numeric section. This fixes the small handful of outliers. This makes it easy to convert these headers to common markup formats, for example: http://hyperpolyglot.org/lightweight-markup

remove trailing whitespace `sed -i 's, *$,,' *.txt`

e899eab

eighthave changed the title ~~standardize format~~ Bug32619: fix syntax errors in torspec documents Nov 26, 2019

torproject-pusher merged commit e899eab into torproject:master Nov 26, 2019

eighthave deleted the standardize-format branch Nov 26, 2019

torproject / torspec Public

Bug32619: fix syntax errors in torspec documents #95

Bug32619: fix syntax errors in torspec documents #95

eighthave commented Nov 26, 2019

torproject / torspec Public

Bug32619: fix syntax errors in torspec documents #95

Bug32619: fix syntax errors in torspec documents #95

Conversation

eighthave commented Nov 26, 2019