docs: rewrite README and add usage, configuration, contributing guides - #2
Merged
Merged
Conversation
Bring documentation back in line with the current CLI. The previous README mislabeled the `scan -o` flag (`--format` vs the actual `--output-format`) and the `template -o` flag (`--format` vs `--output`), and was missing `--fail-on-error`, `--set`, `-l/--list-environments`, and the fact that `template` accepts multiple chart paths. Split the monolithic README into a short landing page plus dedicated docs: - README.md: trimmed to intro, install, prerequisites, quickstart, demo, doc index. Adds CI badges and a `go install` install option. - docs/usage.md: full command reference with corrected flag names, exit codes for `scan`, output-format descriptions, and recipe-style examples. - docs/configuration.md: chartscan.yaml schema, path resolution rules, environments, git-root auto-discovery, CLI override precedence. - CONTRIBUTING.md: prerequisites (Go 1.26+, Helm), repo layout, local dev, testing (including the test.sh caveat), CI workflows, PR steps.
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.
Bring documentation back in line with the current CLI. The previous README
mislabeled the
scan -oflag (--formatvs the actual--output-format)and the
template -oflag (--formatvs--output), and was missing--fail-on-error,--set,-l/--list-environments, and the fact thattemplateaccepts multiple chart paths.Split the monolithic README into a short landing page plus dedicated docs:
doc index. Adds CI badges and a
go installinstall option.codes for
scan, output-format descriptions, and recipe-style examples.environments, git-root auto-discovery, CLI override precedence.
dev, testing (including the test.sh caveat), CI workflows, PR steps.