docs: say why before showing the verification - #2
Merged
Merged
Conversation
The README opened with how the queries are verified against a live server -- methodology, before the reader had any reason to care. The section explaining the problem (the catalogue views already hold the answer; reading them means a dozen queries and ratio maths by hand) sat at line 63. Move it above.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Free Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README now places the “Why” section near the introduction. The section explains PostgreSQL catalogue queries, metric calculations, and ranked findings. ChangesDocumentation update
Estimated code review effort: 1 (Trivial) | ~2 minutes Note 🎁 Summarized by CodeRabbit FreeYour organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Essentials by visiting https://app.coderabbit.ai/settings/billing. Comment |
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.
The README led with the live-server verification — methodology, before the reader knew why they wanted the tool. The
## Whysection sat at line 63.Reordered: what it is → why it exists → how it is verified → how it works.
Gate passes.
Summary by CodeRabbit