docs: fix validation findings#185
Open
tupe12334 wants to merge 1 commit into
Open
Conversation
SECURITY.md pointed at a nonexistent steplock-core crate instead of steplock. Installation.md and core/README.md didn't mention the steplock validate / steplock clean subcommands or the validate module.
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
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.
SECURITY.md:9 — crates.io link pointed at a nonexistent
steplock-corecrate (published crate issteplock, percore/Cargo.tomland the README badge) — fixed link to https://crates.io/crates/steplockInstallation.md:174 —
steplock validateandsteplock cleanCLI subcommands (seecore/src/bin/main.rs) were undocumented — added an "Other commands" sectioncore/README.md:14 — Modules table omitted the public
validatemodule (validate_checklists, used bysteplock validate) — added a row for it