IntersectMBO / plutus

The Plutus language implementation and tools
Apache License 2.0
1.57k stars 479 forks source link

Move from asciidoc to Markdown #6023

Open bezirg opened 6 months ago

bezirg commented 6 months ago

We use some asciidoc in the repo, let's get rid of it

Unisay commented 6 months ago

I don't know why it was decided before me that ASCIIDoc is a thing to use, I assume there were reasons. (I'd prefer to learn about them from an ADR, but I couldn't find one, probably there isn't, unfortunately)

Its also fair to assume that one alternative is not universally better than another (otherwise we wouldn't have this choice?), so there must be aspects that are better in ASCIIDoc than in Markdown.

The task description is very quick, it doesn't let me answer the main question "Why?".

bezirg commented 6 months ago

@Unisay Checking now our discussion, the reason is that AsciiDoc does not render properly in Github. Specifically the links were/are broken.