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.

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

Convert Specification PDF to Markdown #43

Closed
keithrfung opened this issue Nov 7, 2020 · 0 comments · Fixed by #54
Closed

Convert Specification PDF to Markdown #43

keithrfung opened this issue Nov 7, 2020 · 0 comments · Fixed by #54
Assignees
Labels
code owner only Only for Code Owner documentation Improvements or additions to documentation

Comments

@keithrfung
Copy link
Collaborator

Feature Request

Is your feature request related to a problem? Please describe.

Convert the most current version of the specification to markdown so that it can be displayed by mkdocs.
https://github.com/microsoft/electionguard/releases/tag/v0.95.0

Describe the solution you'd like
We'd like the specifications to be as accessible and visible as possible. The first steps to this are having a easily a form that can be easily navigated to and traversed.

The material theme we use for mkdocs has some great examples of using arithmatex. The hope would that many of the equations could be displayed with this.
https://squidfunk.github.io/mkdocs-material/reference/mathjax/#arithmatex

@keithrfung keithrfung added good first issue Good for newcomers help wanted Extra attention is needed labels Nov 7, 2020
@keithrfung keithrfung added the documentation Improvements or additions to documentation label Jan 11, 2021
@keithrfung keithrfung added code owner only Only for Code Owner and removed good first issue Good for newcomers help wanted Extra attention is needed labels Jan 12, 2021
@keithrfung keithrfung mentioned this issue Jan 26, 2021
9 tasks
@rc-ms rc-ms closed this as completed in #54 Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code owner only Only for Code Owner documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants