This repository was archived by the owner on Sep 20, 2026. It is now read-only.
docs: link CLI users to ScopeQL documentation - #45
Merged
Merged
Conversation
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Summary
scopeql --helpscopeql -houtput conciseWhy
The CLI name is also the language name, but neither the repository nor the command help directed users to the canonical language documentation. This made the CLI easy to mistake for the ScopeQL language manual.
Impact
CLI users and agents can identify the interface/language boundary and reach exact syntax documentation without external search.
Validation
cargo +nightly fmt --all -- --checkcargo +1.97.1 clippy --workspace --all-targets --all-features -- -D warningscargo +1.97.1 test --workspace --all-targets— 39 tests passedscopeql --helpandscopeql -hgit diff --check