Add comprehensive user guide documentation#40
Merged
Malcolmnixon merged 3 commits intomainfrom Jan 10, 2026
Merged
Conversation
- Create docs/guide/guide.md with complete user documentation - Include introduction, prerequisites, installation instructions - Document YAML requirements file format with examples - Detail command-line interface and all options - Explain exporting capabilities for reports and trace matrices - Add comprehensive FAQ covering 30+ common questions - Follow markdown linting rules (120 char max, ATX headers) - Use reference-style links throughout - Provide practical examples for all features
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add user guide document in Markdown format
Add comprehensive user guide documentation
Jan 9, 2026
Malcolmnixon
approved these changes
Jan 10, 2026
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 user guide at
docs/guide/guide.mdcovering ReqStream usage, YAML format specification, and common workflows.Contents
Example YAML Structure
Changes
docs/guide/guide.md(734 lines).cspell.jsondictionaryOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.