Add comprehensive user instructions#2
Merged
Conversation
- Create USER-INSTRUCTIONS.md with step-by-step usage guide - Include installation, basic usage, and advanced workflows - Add troubleshooting section and CI/CD integration examples - Provide practical examples for documentation audits and quality monitoring - Cover common use cases: pre-agent validation, developer feedback loops - Include JSON data usage for automation and custom scoring logic Complements README.md with practical, copy-paste ready instructions for end users.
ps0394
pushed a commit
that referenced
this pull request
Apr 21, 2026
Sequences the clipper-improvement-issues.md backlog into 6 phases with prerequisites, exit criteria, and PR-sized scope per phase. Key differences from the original backlog: - Issues #1 and #2 merged into a single 'rendering-mode dimension' - Issue #3 promoted to P0 (biggest accuracy improvement) - Issue #6 promoted (transforms report usability at Learn scale) - Issue #9 reframed from 'nice-to-have' to strategic ground-truth validation - Issue #7 rejected (measurement tool, not discovery tool) - Three missing prerequisites added: test suite, failure-mode transparency, evaluator reproducibility - Azure migration integrated as Phase 5 between refinement and LLM work
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
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.
Complements README.md with practical, copy-paste ready instructions for end users.