Repository navigation
docs: document the GitHub scan options in the command reference - #46
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 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.
Tier: low. Documentation only.
Fixes #45.
site/scripts/check_reference.pyfailed on main becausecdg scanhas five options the command reference did not list.site/commands.mdandsite/ko/commands.mdnow document--github,--ref,--path,--authand--max-file-sizein the scan option table, with the wording ofcdg scan --help, plus one sentence that a GitHub repository is read the same way without cloning, and one example (cdg scan OWNER/REPO --github --ref v1.2 --path src/app.py:40-60).Tested locally:
uv run python site/scripts/check_reference.pyfailed with the ten "not documented" lines before and printsreference matches the CLI: 21 commands, 112 optionsafter. The option syntax of the new example was run against this repository (--github --ref main --path LICENSE:1-3returns the three lines;--max-file-size 1KBlists LICENSE as skipped). Not run locally: the site build andcheck_links.py(they need the npm build); the docs workflow on this PR runs them.