docs: refactor docs/spec to use mdbook #1161
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes EDGA-821
Still a wip so leaving as DRAFT, but curious for people's opinion here.
Using https://rust-lang.github.io/mdBook/index.html to publish the spec and further technical documentation in one place.
Mdbook has mathjax support, but they somehow don't support
$...$
notation, so we have to replace all of them with\\( \\)
(not sure whether this is mathjax-specific syntax or if latex supports this syntax as well). I changed all the $s in overview.md but haven't touched the other pages yet.To view the book, need to
Looks like
for now but we'll prob want to reorganize the overview into a more book-like format.
Why are these changes needed?
Checks