Add an in-app User Guide and standalone PDF

Internal

Public Access

Adds docs/USER_GUIDE.md, a 10-section end-user guide (getting
started, managing/organizing profiles, SSH and RDP connections,
session management, settings, troubleshooting). It's embedded into
the app binary via a Qt resource file and rendered by a new
Help -> User Guide window: a topic sidebar plus content pane, not a
single scrolling document, with cross-reference links between
sections routed to sidebar selection rather than relying on Qt's
Markdown importer's lack of heading anchors.

A separate, non-shipped tool (tools/user-guide-pdf/) renders the
same source to a standalone PDF via QTextDocument + QPrinter,
wrapped by packaging/docs/build-user-guide-pdf.sh. Kept fully
outside the main CMake target so Qt6::PrintSupport never becomes a
runtime dependency of the shipped app (confirmed via ldd). The PDF
itself isn't committed -- generated per release like the platform
installers.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

This commit is contained in:

ksmith

2026-09-08 18:17:21 -06:00

co-authored by

Claude Sonnet 5

parent 80bc50e54c

commit ce1e40a12d

12 changed files with 522 additions and 0 deletions

									
										CMakeLists.txt
									
		+3
		
												View File
												
				@@ -81,6 +81,9 @@ add_subdirectory(third_party/FreeRDP EXCLUDE_FROM_ALL)

				set(ORBITHUB_SOURCES

				    src/about_dialog.cpp

				    src/about_dialog.h

				    src/user_guide_dialog.cpp

				    src/user_guide_dialog.h

				    docs/user_guide.qrc

				    src/app_icon.cpp

				    src/app_icon.h

				    src/main.cpp