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

First cut at conversion from LaTeX to mdbook for the CHERI C/C++ guide. #38

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

rwatson
Copy link
Member

@rwatson rwatson commented Jul 18, 2023

There are known nits including with compiler warning formatting and equations.

Not yet a merge candidate.

There are known nits including with compiler warning formating and equations.
@rwatson rwatson added the enhancement New feature or request label Jul 18, 2023
@rwatson rwatson self-assigned this Jul 18, 2023
@rwatson
Copy link
Member Author

rwatson commented Jul 18, 2023

Reviewer note: With the exception of the above-mentioned note about equation and compiler warning formatting, this is believed to be a fairly complete and very literal conversion from LaTeX to mdbook. In some places I’ve had to make minor content changes to reflect the new format (e.g., the reading section). My main worry right now is that I’ve dropped or duplicated content as a result of breaking things out into separate files, hooking them up, etc., so additional eyes would be welcome.

I’ll poke the formatting on the above a bit more tonight, but would love to get this live sooner rather than later so that we can facilitate future changes, as hopefully mdbook will make for a better living document format. Also, it will now be easy to link directly to sections of the report when answering questions in Slack, in the FAQ, etc.

@brooksdavis
Copy link
Member

The presence of src/impact/README.md.bak breaks mdbook serve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants