docs(getting-started): replace invented scan example with real output#15
Merged
Conversation
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
The "First scan" example in
docs/getting-started.mdinvented column names (CLASS/FIX) that don't exist in the terminal output and used lowercase severities. Replaces the block with the actualremetric scanoutput captured against the e2e demo stack, including:▶ cardinality... done (120ms)etc.).SEVERITY/METRIC/LABEL/SERIES/UNIQUE/EST. REDUCTION).CRITICALrow, including the paste-readymetric_relabel_configssnippet and theReference:link to the docs page (the link populated by PR feat(docs): findings reference site at remetric.dev + DocURL in every finding #13's DocURL wiring).Rewrites the "Reading the report" section to describe the three layers actually visible (phase tracker, severity table, per-finding detail), with column meanings.
Test plan
mkdocs build --strictclean.https://remetric.dev/getting-started/#first-scanshows the new example.