Repository navigation
Verify Structure workflows and add contextual ReadMe screenshots - #7
jamesfrking wants to merge 7 commits into
Conversation
Greptile SummaryThis PR updates Structure-management guidance against the staging UI, adds contextual screenshots and reusable network artwork, expands media/content validation, and introduces Userpilot presentation styles.
Confidence Score: 4/5The PR is not yet safe to merge because the unresolved release-gate thread still allows checks to pass when required launch approvals and evidence are incomplete. The workflow still catches a failing Files Needing Attention: .github/workflows/docs-quality.yml, integration/userpilot-network-icons.css
|
| Filename | Overview |
|---|---|
| docs/Structures, Elements, and Collections/create-and-manage-structures.md | Rewrites Structure creation, editing, refresh, and deletion-review instructions and places two matching screenshots beside the relevant steps. |
| CONTRIBUTING.md | Reconciles screenshot standards by documenting the theme-neutral frame and explicitly permitting legacy v4 and v5 images during migration. |
| scripts/validate-content.mjs | Extends validation to support synchronized customer-friendly category folder names while preserving canonical article URLs. |
| integration/userpilot-compact-panel.css | Adds compact responsive presentation rules for the staging Userpilot Resource Center; no concrete regression is established. |
| .github/workflows/docs-quality.yml | Runs the launch checklist as an advisory report rather than preserving its blocking exit status. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart LR
S[Source screenshots and SVG assets] --> B[Media generation scripts]
B --> M[Media and placement manifests]
M --> V[Content and media validators]
M --> D[ReadMe documentation pages]
D --> R[Draft documentation preview]
V --> CI[Docs checks workflow]
CI --> A[Advisory launch checklist]
Reviews (5): Last reviewed commit: "Version compact staging Resource Center ..." | Re-trigger Greptile
| if npm run check:release > "$RUNNER_TEMP/docs-release-report.txt" 2>&1; then | ||
| echo '### Launch checklist: complete' >> "$GITHUB_STEP_SUMMARY" | ||
| else | ||
| { | ||
| echo '### Launch checklist: follow-up items remain' | ||
| echo '' | ||
| echo 'Advisory only: this checklist does not block routine documentation fixes. Passing this PR does not certify release readiness or replace Product and Support review.' | ||
| echo '' | ||
| echo '<details><summary>View outstanding release items</summary>' | ||
| echo '' | ||
| echo '```text' | ||
| cat "$RUNNER_TEMP/docs-release-report.txt" | ||
| echo '```' | ||
| echo '</details>' | ||
| } >> "$GITHUB_STEP_SUMMARY" |
There was a problem hiding this comment.
For non-draft pull requests targeting v1.0 and pushes to v1.0, this failure branch only writes to the job summary and then returns successfully. The repository currently has visible draft pages, incomplete visual coverage, and a publication gate that is not ready, all of which check:release is designed to reject. Swallowing its exit status removes the repository's only automated release gate, allowing CI to pass before the documented approvals and release evidence are complete.
| } | ||
| if (screenshot.style !== 'wanaware-ai-assisted-v4') { | ||
| fail(screenshotManifestFile, `captured screenshot must use wanaware-ai-assisted-v4: ${screenshot.file}`); | ||
| if (!['wanaware-ai-assisted-v4', 'wanaware-navy-teal-v5'].includes(screenshot.style)) { |
There was a problem hiding this comment.
Screenshot Standards Now Conflict
The validator now approves wanaware-navy-teal-v5, and the two new Structure screenshots use that style, while CONTRIBUTING.md still requires wanaware-ai-assisted-v4. This gives contributors and CI conflicting definitions of an approved screenshot. Either document and permit the v5 frame or keep these assets on the required v4 frame.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| #userpilot-resource-centre .row[role="link"][aria-label*="https://docs.wanaware.com/docs/"]::before { | ||
| content: ""; | ||
| display: block; | ||
| width: 44px; | ||
| height: 44px; | ||
| min-width: 44px; | ||
| flex: 0 0 44px; | ||
| margin-right: 12px; | ||
| background: var(--wanaware-help-icon) center / contain no-repeat; | ||
| pointer-events: none; |
There was a problem hiding this comment.
The generic selector adds a fixed 44px icon box and margin to every WanAware documentation link, but configured destinations such as delete-assets-safely, understand-billing, and sign-in-password-and-mfa have no icon mapping. Those resource-centre rows therefore show blank icon space and inconsistent alignment. Scope the pseudo-element to mapped rows or provide a fallback icon.
Changes
Verification
Release boundary
Draft preview only. Do not merge or publish until Product and Support approve. New article render verification, saved-result capture, normal-role verification, and broader release gates remain outstanding. API Reference unchanged. No planning or agent-instruction Markdown included.