Skip to content

Improve customer documentation journeys - #6

Merged
jamesfrking merged 7 commits into
v1.0from
v1.0_kb-customer-docs-improvements
Sep 4, 2026
Merged

jamesfrking merged 7 commits into
v1.0from
v1.0_kb-customer-docs-improvements

Conversation

@jamesfrking

Copy link
Copy Markdown
Contributor

Customer outcome

Makes the knowledge base easier to enter, scan, search, and continue through without exposing internal review notes.

Included

  • Two one-click Welcome paths: Explore WanAware and Build your environment
  • Customer-friendly category overview pages
  • Removal of duplicate page titles and unapproved video placeholders
  • Symptom-led troubleshooting titles and expanded search language
  • Compact task tables and explicit next steps
  • Preview-versus-release validation gates
  • Service Catalog bulk-upload guides hidden until end-to-end verification succeeds

Verification

  • npm run check passes for 68 guide pages and 87 screenshot slots
  • npm run check:media passes for all 41 ReadMe-hosted PNGs
  • No planning or agent-instruction Markdown is included

Remaining release blockers

  • Complete the outstanding action screenshots in the authenticated dev workspace
  • Verify Service Catalog bulk upload end to end
  • Run the rendered ReadMe preview and Docs Audit
  • Pass live search and redirect checks
  • Obtain Product and Support approval

This PR must remain in draft and must not merge into v1.0 until every release gate passes.

@jamesfrking
jamesfrking marked this pull request as ready for review September 4, 2026 13:55
@greptile-apps

greptile-apps Bot commented Sep 4, 2026 •

Copy link
Copy Markdown

Greptile Summary

This PR substantially restructures the customer documentation into clearer entry paths, category overviews, task journeys, troubleshooting routes, and explicit next steps. It also adds and places sanitized screenshots, hides unverified Service Catalog bulk-upload guides, and strengthens release validation.

  • Adds ready_for_review workflow handling so release checks run when a draft PR becomes mergeable.
  • Introduces customer-oriented navigation and removes duplicate body titles and unapproved media placeholders.
  • Adds screenshot manifests, placements, and visual-coverage records for key administration and Asset Type workflows.
  • Keeps unfinished pages and the overall publication gate blocked pending release evidence and approvals.

Confidence Score: 5/5

The PR appears safe to continue through its documented draft review process, with no unresolved code defect identified in the latest changes.

The previously reported workflow-trigger issue is fully fixed by adding ready_for_review, and its thread is resolved. Newly added draft content and pending media remain protected by the live release-mode checks and the blocked publication gate, so no blocking failure remains in the reviewed changes.

Important Files Changed

Filename Overview
.github/workflows/docs-quality.yml Adds the ready-for-review trigger and conditionally enforces live-release validation for mergeable v1.0 pull requests and v1.0 pushes.
scripts/validate-content.mjs Expands structural, linking, media, visual-coverage, and publication-gate validation for the documentation release.
integration/publication-gate.json Records the remaining workflow, media, Support, search, usability, and preview blockers that prevent publication.
media/publishing-manifest.json Registers the newly captured ReadMe-hosted screenshots with checksums, dimensions, article associations, and pending approval states.
docs/start-here/choose-your-path.md Provides the two primary customer entry journeys for exploration and environment setup.
docs/administration-and-personal-settings/create-and-edit-roles.md Updates current IAM labels, adds workflow screenshots, and expands safe Role-deletion guidance while retaining draft status.
docs/asset-types-and-service-catalog/create-a-custom-asset-type.md Adds action guidance, draft and confirmation screenshots, and a guarded deletion procedure while retaining draft status.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Welcome[Welcome and path selection] --> Explore[Explore WanAware]
  Welcome --> Build[Build your environment]
  Explore --> Categories[Customer category overviews]
  Build --> Workflows[Guided setup workflows]
  Categories --> Workflows
  Workflows --> Verify[Expected results and verification]
  Verify --> Troubleshoot[Symptom-led troubleshooting]
  Verify --> Continue[Learn and continue / next steps]
  Troubleshoot --> Support[WanAware Support]
  Workflows --> ReleaseGate{Release gates complete?}
  ReleaseGate -->|No| Draft[Remain draft or hidden]
  ReleaseGate -->|Yes| Publish[Publish to v1.0]
Loading

Reviews (5): Last reviewed commit: "Add verified admin and asset type workfl..." | Re-trigger Greptile

Comment thread .github/workflows/docs-quality.yml Resolved
@jamesfrking
jamesfrking merged commit 9c7176c into v1.0 Sep 4, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant