search

cardano-scaling / hydra

Implementation of the Hydra Head protocol
https://hydra.family/head-protocol/
Apache License 2.0
282 stars 86 forks source link

Make specification editing in markdown possible #1187

Open ghost opened 11 months ago

ghost commented 11 months ago

So far, the specification was written in LaTex and rendered to a PDF. LaTeX was a good choice because of its expressiveness on math expressions, but not so great a choice for pull requests and the entry barrier is quite high. The majority of documentation around Hydra and Mithril is written using Markdown and rendered into a webpage using a static site generator, currently Docusaurus. Most modern Markdown renderers do support LaTeX-style math nowadays, even the normal GitHub file preview.

Hence, we aim to be using more approachable Markdown format to write the specification, but still being able to use LaTeX math and LaTeX macros (which are still heavily used in the spec), to produce both, a PDF and HTML rendering.

ghost commented 11 months ago

Blocked on decision about what to do with GIF

ch1bo commented 11 months ago

Blocked on decision about what to do with GIF

Not really. The GIF was only for the monthly report https://github.com/input-output-hk/hydra/pull/1189

ghost commented 11 months ago

OK, then it's unblocked.

ch1bo commented 4 months ago

Related to #843