Repository navigation
doc(doc-site): document the CLI tools codescan ships - #115
Merged
Merged
Conversation
The site described codescan as a library and as a terminal UI, and its options as Go struct fields. The commands now share one flag surface and one configuration contract, so a field is one of three spellings of the same knob — and the command most people will put in a build had no page at all. Getting started: - a page for genspec: the two output streams, choosing the document, the diagnostics flags, what -validate checks and how a finding is located, and what each exit status means. It closes on genspec-wasi, for a sandbox or an image with no Go in it. - the terminal UI page catches up with the shared surface: -loader replaces -toolchain-free-loader, every option is both a flag and a live toggle rather than one or the other, -packages is the deprecated spelling of positional patterns, and the TUI does read a configuration file. The run-cost card and the -profile flags are documented, with captures of both. Usage, a section until now holding a placeholder that linked out to GitHub for material this site has carried since June: - the options reference moves here from the maintainers compendium, every row gaining the flag that writes it and the section a .codescan.yaml addresses it in; - a page for the rules those two columns follow: how a flag name derives from a field, what a configuration file may hold, where it is looked for, and that anything typed wins over it. Maintainers gains a page on how the commands are put together: why each lives in the module it does, the guard that fails the build when an option lands with no flag, and the seam that keeps the configuration package usable from the WebAssembly build. Also: the playground box can be expanded or taken full screen, for a reader who has stopped reading and started using it; the version parameters generated at build time are rendered rather than ignored; and the worked petstore example becomes the first tutorial instead of an orphan under the placeholder. The flag and section columns of the reference were filled from the flag tables themselves rather than transcribed, so all forty rows are the code's answer. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
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.
The site described codescan as a library and as a terminal UI, and its options as Go struct fields. The commands now share one flag surface and one configuration contract, so a field is one of three spellings of the same knob — and the command most people will put in a build had no page at all.
Getting started:
Usage, a section until now holding a placeholder that linked out to GitHub for material this site has carried since June:
Maintainers gains a page on how the commands are put together: why each lives in the module it does, the guard that fails the build when an option lands with no flag, and the seam that keeps the configuration package usable from the WebAssembly build.
Also: the playground box can be expanded or taken full screen, for a reader who has stopped reading and started using it; the version parameters generated at build time are rendered rather than ignored; and the worked petstore example becomes the first tutorial instead of an orphan under the placeholder.
The flag and section columns of the reference were filled from the flag tables themselves rather than transcribed, so all forty rows are the code's answer.
Change type
Please select: 🆕 New feature or enhancement|🔧 Bug fix'|📃 Documentation update
Short description
Fixes
Full description
Checklist