docs(ums-cli): Update README.md based on current source code#125
Open
docs(ums-cli): Update README.md based on current source code#125
Conversation
Co-authored-by: synthable <374893+synthable@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README.md for package ums-cli
docs(ums-cli): Update README.md based on current source code
Dec 15, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the ums-cli README.md to accurately reflect the current CLI implementation, correcting outdated guidance and adding missing documentation for various command options and features.
Key Changes:
- Updated
validatecommand documentation to reflect runtime validation via SDK'svalidateAll()instead of outdated "use tsc --noEmit" guidance - Added missing command options:
--emit-declarationsfor build,--sourcesfor inspect, and documented support for cognitive level enum names - Corrected dependency reference from
ums-libtoums-sdkand marked MCP commands as stubs (not yet implemented)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Verbose mode (adds extra tips) | ||
| # Validate a specific path | ||
| copilot-instructions validate ./instructions-modules |
There was a problem hiding this comment.
The example path ./instructions-modules is inconsistent with the configuration example and project structure section which use ./instruct-modules-v2. Consider updating this example to use ./instruct-modules-v2 for consistency throughout the documentation.
Suggested change
| copilot-instructions validate ./instructions-modules | |
| copilot-instructions validate ./instruct-modules-v2 |
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.
README.md was out of sync with the actual CLI implementation. Updated to reflect current behavior.
Key Changes
validateAll()instead of outdated "use tsc --noEmit" guidance--emit-declarationsoption and output file documentation (.build.json,declarations/)--sourcesoptionums-libtoums-sdkMinor Updates
UNIVERSAL_PATTERNS)Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.