-
Notifications
You must be signed in to change notification settings - Fork 9
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 RTC product guide to markdown #11
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our current mkdocs + material theme can handle a central glossary and hover over definitions of terms in the glossary: https://squidfunk.github.io/mkdocs-material/reference/abbreviations/ |
It might be worth using mkdocs-bibtex to support citation management |
d026d41
to
afe0b90
Compare
jhkennedy
approved these changes
Mar 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Still a ways off, but wanted to at least but the draft in front of people and see if we like the styling.
images are missingI took out the section numbers but I'm considering adding them back inQuestion posed in Should we include section numbers in the RTC product guide? #60I took out the abbreviations section but I'm considering putting it back (maybe on a separate page)Opened issue Include a glossary #59 to do this latermkdocs only provides anchors and TOC entries for H2 and H3 headers, not H4, so there's a link toQuantifying Change over Time
that's broken at the momentstill need to fix the production document having two Figure 5scitations aren't quite formatted correctly (needs to indent on word-wrap)Opened issue Need better reference/citation formatting #61 to trackAlso updated some out-of-date content:Opened #62 to trackREADME.txt
is nowREADME.md.txt
iso.xml
is removed