Add ORNLSlicer user guide - #243
Draft
aroschli wants to merge 26 commits into
Draft
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Copy link
Copy Markdown
Collaborator
Author
|
Update on the follow-up changes now included in this draft PR:
Validation performed locally:
Current PR head: 269ffb81. CI is green for the guide workflow, Ubuntu, macOS, Linux, and Windows as of this comment. |
Sorry, something went wrong.
liamnwhite1
force-pushed
the
docs/add-new-user-manual
branch
3 times, most recently
from
d0f9d27 to
43d7dfa
Compare
August 24, 2026 17:19
- Replaced the ORNLSlicer User Guide PDF with a new version (size reduced from 2,199,266 to 2,126,694 bytes). - Updated the link in the Home.md documentation to point to the ORNLSlicer User Guide in Markdown format instead of PDF.
- Revised tooltips for thermal scanner, auto speed ramping, file output, and cross-sectioning settings to provide clearer descriptions of their functionality and limitations. - Introduced a new script, `generate_settings_reference.py`, to automate the generation of a detailed settings appendix for the ORNLSlicer user guide, ensuring consistency and accuracy in documentation. - Enhanced the README to include instructions for regenerating the settings reference after changes to the YAML files.
liamnwhite1
force-pushed
the
docs/add-new-user-manual
branch
from
43d7dfa to
9bd3294
Compare
August 25, 2026 12:06
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
At least 1 approving review is required to merge this pull request.
2 participants
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.
Summary
Why
This gives users and release packages a single structured manual for GUI, CLI, settings, slicing, G-code, projects, preferences, and troubleshooting workflows. The settings appendix is generated so it stays aligned with the canonical settings metadata.
Validation
Note: I could not regenerate the PDF after adding the placeholder-color filter in this environment because Pandoc/LaTeX are not installed, and the temporary Nix toolchain path attempted a very large bootstrap build.