Repository navigation
Improve customer documentation journeys - #6
Conversation
Greptile SummaryThis 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.
Confidence Score: 5/5The 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
|
| 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]
Reviews (5): Last reviewed commit: "Add verified admin and asset type workfl..." | Re-trigger Greptile
Customer outcome
Makes the knowledge base easier to enter, scan, search, and continue through without exposing internal review notes.
Included
Verification
Remaining release blockers
This PR must remain in draft and must not merge into v1.0 until every release gate passes.