Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make specification editing in markdown possible #1187

Open
abailly-iohk opened this issue Nov 29, 2023 · 4 comments
Open

Make specification editing in markdown possible #1187

abailly-iohk opened this issue Nov 29, 2023 · 4 comments
Labels
task Subtask of a bigger feature. tidying A small change improving the "habitability" of the code. Emphasis on small.

Comments

@abailly-iohk
Copy link
Contributor

abailly-iohk commented Nov 29, 2023 •
edited by ch1bo
Loading

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.
@abailly-iohk abailly-iohk mentioned this issue Nov 29, 2023
Closed
16 tasks
@ch1bo ch1bo self-assigned this Nov 29, 2023
@abailly-iohk abailly-iohk added the tidying A small change improving the "habitability" of the code. Emphasis on small. label Nov 30, 2023
@abailly-iohk
Copy link
Contributor Author

Blocked on decision about what to do with GIF

@ch1bo
Copy link
Collaborator

ch1bo commented Dec 1, 2023

Blocked on decision about what to do with GIF

Not really. The GIF was only for the monthly report #1189

@abailly-iohk
Copy link
Contributor Author

OK, then it's unblocked.

@ch1bo ch1bo added the task Subtask of a bigger feature. label Dec 12, 2023
@ch1bo ch1bo removed their assignment Jan 2, 2024
@ch1bo ch1bo changed the title Make specification editing in markdown possible (tidy first) Make specification editing in markdown possible Jun 18, 2024
@ch1bo
Copy link
Collaborator

ch1bo commented Jun 18, 2024

Related to #843

@ch1bo ch1bo mentioned this issue Jun 18, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
task Subtask of a bigger feature. tidying A small change improving the "habitability" of the code. Emphasis on small.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ch1bo @abailly-iohk