search

SoarGroup / SoarGroup.github.io

Soar's website: documentation, news, announcements, links, etc.
http://soar.eecs.umich.edu/
Other
4 stars 1 forks source link

Initial commit Soar manual #3

Closed moschmdt closed 6 months ago

moschmdt commented 8 months ago

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.

moschmdt commented 7 months ago

@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.

garfieldnate commented 7 months ago

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?

moschmdt commented 7 months ago

I think so, too. This will simplify and increase the robustness of the following PRs I guess.

garfieldnate commented 6 months ago

I'm going to merge this in as-is and add your TODO comment as a new issue. Thanks for all your work!