Initial commit Soar manual #3
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
Test pdf generation path fix Change pipeline conditions
|
@garfieldnate sorry for pinging you. Any chance you have time to look at it? I would like to link against it in our internal docs. |
|
Ah sorry, I hadn't seen this! I've updated my watch settings so next time I'll be notified immediately. I don't have time to look through these atm, but probably will by the end of the month. Should I be looking at #4 first? |
|
I think so, too. This will simplify and increase the robustness of the following PRs I guess. |
|
I'm going to merge this in as-is and add your TODO comment as a new issue. Thanks for all your work! |
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.
This PR adds the Soar manual and a CI pipeline to build the manual as PDF and upload it as an output artefact.
This is not a 100% solution right now, because some parts have not been compared completely to the original PDF Soar version.
The following chapters should be very close to the original version:
For chapter 9 I decided to link to the CLI documentation that is included in the PDF anyways. A pandoc filter, cf.
path_filter.lua, is used to keep the links inside the conversion from multiple Markdown files to a single PDF document valid. Unfortunately, this requires that links to other parts of the Soar manual must include a section reference.Unfortunately, I did not have time to go through the other chapters and compare them very closely to the manual about formatting and completeness.