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 long-form documentation to the CLI via the help command.
Purpose
Users need guidance on workflows, troubleshooting, and feature-specific topics that do not fit in command help text. The Quire CLI needed extended documentation, beyond scope of the Commander.js built-in
--helpoutput.Requirements for extended documentation:
Architecture Decisions
helpcommand to delegate to a "help content library"lib/help/topics/) and maintained as part of code change and review processjs-yamllibrary for markdown files with YAML front-matterlib/help/index.js) with a simple API that provides methods togetTopicListandgetTopicContenthelpers/pager.js) for long content (this should respect the system$PAGERenvironment setting)Content for topics is maintained as markdown files in the repository
cli/src/lib/help/topics/directory.See the Help Topic System documentation included with this pull-request.