docs: correct the default tool set, audit flag, and audit-log claims - #3
Merged
Merged
Conversation
Why A full re-audit against the real source turned up four inaccuracies in the docs merged last: the default tool set, the strict-role check, the audit flag, and what the audit log actually keeps. A reader following any of these would hit a flag that doesn't exist or trust a data-handling claim that leaves out a real detail. What changed CHANGELOG names all three default tool groups (object, read, health), not two, and adds rds_superuser to the strict-role list, matching crates/ownpg-core/src/connect/role.rs. The audit flag is `--no-audit`, not `--audit`; there is no `--audit` flag in the CLI. SECURITY now discloses that a short statement, 200 characters or fewer once normalized, is kept in the clear alongside its hash, not only hashed, and points to `ownpg man` instead of README for the audit-log path, since README never stated it. AGENTS.md and CLAUDE.md both dropped "New" from one sentence, a word this project's own blueprint bans outside a changelog. Risk None. Docs only, no code or CI change.
Code Review by Qodo🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)
Great, no issues found!Qodo reviewed your code and found no material issues that require reviewTip of the day💡 Did you know, you can start a comment with 'qodo' or '@qodo' to chat about any finding |
PR Summary by QodoCorrect tool, role, audit flag, and audit-log documentation
AI Description
Diagram
High-Level Assessment
Files changed (4)
|
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.
Summary
Fixes four factual inaccuracies in the docs merged last, all found by a full re-audit against
the real source rather than a re-read of the same files.
Motivation
The previous documentation pass created README, CHANGELOG, SECURITY, AGENTS.md, and CLAUDE.md,
but a follow-up audit dispatched fresh agents to check every claim against the actual code
again, and four of them didn't hold up: a wrong default tool count, a missing strict-role
condition, a flag that doesn't exist, and an audit-log claim that left out a real detail.
Changes
CHANGELOG.md: the default tool set is object, read, and health, three groups, not two.Added
rds_superuserto the strict-role check, matchingcrates/ownpg-core/src/connect/role.rs. Replaced the nonexistent--auditflag with thereal one,
--no-audit.SECURITY.md: disclosed that a short statement, 200 characters or fewer once normalized, iskept in the clear alongside its hash, not only hashed. Repointed the audit-log-path reference
from
README.md, which never states it, toownpg man, which does.AGENTS.mdandCLAUDE.md: dropped "New" from one sentence, a word this project's ownblueprint bans outside a changelog. Both files stay byte-identical.
Type of Change
feat)fix)refactor)docs)perf)test)build/ci)chore)!to type)Testing
Test type:
Steps to verify:
crates/ownpg-core/src/connect/role.rs,crates/ownpg/src/cli.rs,crates/ownpg-core/src/tools/read.rs, andcrates/ownpg-core/src/audit.rs.diff AGENTS.md CLAUDE.md: identical.rgfor an em dash, a markdown table, and emoji across all four files: zero hits.Checklist