QtFRED help dialog and documentation#7380
Open
MjnMixael wants to merge 6 commits intoscp-fs2open:masterfrom
Open
QtFRED help dialog and documentation#7380MjnMixael wants to merge 6 commits intoscp-fs2open:masterfrom
MjnMixael wants to merge 6 commits intoscp-fs2open:masterfrom
Conversation
Contributor
Author
|
Builds are failing on Linux with this error: I don't know how to fix that. |
Contributor
Author
|
according to Claude, this is not something I can fix. |
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
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.
Adds the help dialog and written documentation. The actual code changes here are pretty minimal and most of the PR is the written documentation for each dialog. This uses Qt's help system which requires Qt's QSLite SQL driver which this adds to the build workflows. I'm inexperienced with CMAKE but I've got this working such that building QtFRED will compile the help file and copy it next to the exe.
The help system I've setup here is one where SCP will take ownership of keeping the dialog documentation up to date. Any time features are added/changed/removed from a dialog, the associated help html file should also be updated. Additionally, the help dialog will search in
data/freddocsfor loose html files and add them to the Tutorials tab. This is intended to provide mods like FOTG a way to inject mod-specific documentation directly into the help window. These html files will obey the dark/light theme, be searchable, and can link directly internal dialog documentation. An example html file has been included with this PR.An overwhelming majority of the lines/files changed here is the actual documentation files. Some of them, like sexps, are placeholder. I've asked naomi to help write more complete versions because she is an experienced tutor.