docs: documentation quality campaign — feature parity, onboarding golden path, screenshots#505
Merged
Merged
Conversation
…den path, screenshots Close the doc-code drift and onboarding gaps found by the 2026-07 docs quality review: - Document the two shipped-but-undocumented user-facing features, EN+KO, with docs-uat assertions and freshly captured screenshots: * Vulnerabilities "Group by upgrade" view (W9-#53, #500) * Version currency "behind latest patch" signal (#503) - Onboarding golden path: intro now leads with a recommended single route (5-min demo -> first real scan -> production); quickstart gains step 5 "Scan your first real project"; the docker-compose evaluation section delegates its duplicated boot steps to the quickstart (also removing its stale seed command that lacked --demo-only). - ci-integration/github-actions: add a "Before you begin" block covering the three unmet prerequisites a new user hits (network-reachable portal vs localhost demo, API key, project id). - reference/faq: fix the reachability contradiction ("planned" vs shipped for Go via govulncheck). - contributor-guide/releasing: add a pre-tag documentation sweep to the release checklist (release notes from CHANGELOG [Unreleased], guide coverage for every user-facing entry, screenshot capture) so features can no longer ship without guide coverage. - Screenshots: new capture spec (capture_feature_additions.spec.ts, split from the bulk matrix for isolated re-capture) and a deterministic fixed_version fixture in seed_e2e_user.py so the By-upgrade view renders real upgrade clusters; delete eight orphaned 68-byte placeholder PNGs under docs/user-guide/img/. Verified: Docusaurus EN+KO build green (0 broken links/anchors), docs-uat extract 201 steps, ko-style S1/S2 0, seed unit tests 10 passed, both capture specs green against the live dev stack.
haksungjang
added a commit
that referenced
this pull request
Jul 18, 2026
…M-upload naming (#507) Three P1 items from the 2026-07 docs benchmark review: - contributor-guide/getting-started: replace the re-stated dev-stack boot steps with a delegation to Quickstart steps 1-3. The local copy had already drifted: it skipped the env-file and schema-migration steps, so following it verbatim left the health-gated worker blocking 'up'. Last of the three duplicated boot sequences (the other two were converged in #505). - Terminology: 'policy gate' -> 'build gate' across current docs (analysis-types, faq, notifications, github-actions, env-variables heading, policy-design, comparison). The glossary alias and the projects.md reconciliation sentence stay; release notes stay as historical records; code identifiers (policy-gate API path, policy_gate_failed enum) are untouched. Renamed headings keep their old anchors explicitly so no inbound link breaks. - Naming: the SBOM-upload feature is now called 'SBOM upload' in section titles and link texts ('Received SBOMs' / 'uploaded SBOM' variants unified); the scans.md anchor #received-sboms-uploaded is preserved. EN and KO mirrors updated together. Docusaurus EN+KO build green, docs-uat extract 201 steps, ko-style S1/S2 0.
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.
Summary
Closes the gaps found by the 2026-07 documentation quality review (drift, onboarding, screenshots, recurrence prevention). All user-facing docs changes ship EN+KO simultaneously.
1. Feature parity (drift closure)
user-guide/vulnerabilities.md— cluster anatomy, build-gate lock-step semantics,upgrade-clustersAPI with docs-uat assertions, new screenshot.user-guide/components-and-licenses.md— EOL-sibling framing, four drawer states,?outdated=truefilter API with docs-uat assertion, new screenshot.CHANGELOG.md [Unreleased]already covers everything since v0.14.0 accurately. The next tag writes its notes from there (now codified, see §4).2. Onboarding golden path
intro.mdleads with a recommended single route: 5-minute demo → first real scan → production install.quickstart.mdgains step 5 Scan your first real project — the tutorial now ends at real value, not seeded data.installation/docker-compose.mdevaluation section delegates its duplicated boot steps to the quickstart (removing a stale seed command that lacked--demo-only).ci-integration/github-actions.mdgains Before you begin — network-reachable portal (not the localhost demo stack), API key, project id — the three walls a new user hit in the persona walkthrough.reference/faq.mdreachability answer corrected ("planned" → shipped for Go via govulncheck), removing a direct contradiction withanalysis-types.md.3. Screenshots
user-vulns-group-by-upgrade.png,user-components-outdated.png(+318 KB, well under the size gate).capture_feature_additions.spec.ts, split from the bulk matrix so these cuts re-capture without churning untouched baselines.seed_e2e_user.py: deterministicfixed_versionfixture (even-indexed findings) so the By-upgrade view renders real upgrade clusters; odd rows stay NULL to keep the "No upgrade available" state covered. No test depended on the previous all-NULL state.docs/user-guide/img/deleted (referenced nowhere since the screenshot automation series).4. Recurrence prevention
contributor-guide/releasing.md: the release checklist gains a pre-tag documentation sweep — write the release notes fromCHANGELOG.md [Unreleased](EN+KO, sidebar wiring), verify every user-facing entry has guide coverage (missing coverage is a release blocker), capture screenshots for new UI surfaces. This is the fix for how feat(vulnerabilities): Group by upgrade view (W9-#53) #500/feat(components): version currency — 'behind latest patch' signal (BomLens parity #18) #503 shipped guide-less.Verification
extractgreen — 201 steps (4 new assertions)