diff --git a/.github/workflows/docs-quality.yml b/.github/workflows/docs-quality.yml
index 3e5952d..75f7f10 100644
--- a/.github/workflows/docs-quality.yml
+++ b/.github/workflows/docs-quality.yml
@@ -2,6 +2,11 @@ name: Documentation quality
on:
pull_request:
+ types:
+ - opened
+ - reopened
+ - synchronize
+ - ready_for_review
push:
branches:
- v1.0
@@ -19,4 +24,7 @@ jobs:
with:
node-version: 22
- run: npm run check
+ - name: Enforce live-release gates
+ if: (github.event_name == 'pull_request' && github.base_ref == 'v1.0' && github.event.pull_request.draft == false) || github.ref == 'refs/heads/v1.0'
+ run: npm run check:release
- run: npm run check:media
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 245c347..d02b6a3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ Keep one primary purpose per page. Link to nearby troubleshooting instead of add
## Work on the correct branch
-- Use `v1.0_kb-screenshot-system` for the current first-release ReadMe preview and review.
+- Use `v1.0_kb-customer-docs-improvements` for the current customer-experience preview and review.
- Keep upcoming product behavior on an unpublished feature branch.
- Merge to `v1.0` only after Product and Support approval.
- Do not modify API Reference files as part of customer workflow documentation.
@@ -54,6 +54,8 @@ release-status: draft
Use `release-status: draft` while any verification, screenshot, video, or review evidence is pending. Change it to `ready` only when the page has a verified release and date, approved media, and both required reviews.
+ReadMe renders the page title from frontmatter. Do not repeat it as a body H1; begin body sections at H2.
+
## Workflow page contract
Every workflow must include:
@@ -61,16 +63,16 @@ Every workflow must include:
- A 30-second **If you're stuck** section with the fastest safe checks
- Outcome, audience, permission, time, and changes made
- Prerequisites and warnings before consequential actions
-- A field, option, action, or checkpoint table using exact released UI labels
+- Compact field, option, action, or checkpoint tables using exact released UI labels; keep tables to four columns or fewer
- Numbered steps using released UI labels
- Expected results at important checkpoints
- Troubleshooting beside the step where failure occurs
- A final verification procedure
- Undo, detach, or deletion guidance when data changes
-- Learn, Show me, and Do it links where available
+- A **Learn and continue** section with a relevant concept and the exact **In WanAware** navigation path
- Related next steps and the standard Support footer
-The article is authoritative. Hide an embedded clip as soon as its UI or behavior becomes inaccurate.
+The article is authoritative. Add **Show me** only when an approved clip exists, and hide the clip as soon as its UI or behavior becomes inaccurate.
## Troubleshooting page contract
@@ -119,7 +121,7 @@ Before publication:
1. Run every procedure in Harbor Meridian Systems with a normal customer role and the appropriate administrator role.
2. Verify permissions, side effects, background processing, messages, recovery, links, media, and cleanup.
-3. Run `npm run check`.
+3. Run `npm run check`. For a pull request targeting `v1.0`, also run `npm run check:release`.
4. Render the ReadMe branch preview and run Docs Audit.
5. Obtain Product approval for behavior and Support approval for clarity, diagnosis, and escalation.
6. Confirm the complete pull request does not contain planning, agent instruction, handoff, or status documents.
diff --git a/docs/administration-and-personal-settings/choose-a-theme.md b/docs/administration-and-personal-settings/choose-a-theme.md
index fbcd728..be4b941 100644
--- a/docs/administration-and-personal-settings/choose-a-theme.md
+++ b/docs/administration-and-personal-settings/choose-a-theme.md
@@ -28,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Choose a theme
-
**Outcome:** Change your personal appearance without changing another member's settings.
**For:** Signed-in WanAware members
@@ -61,6 +59,9 @@ Theme changes affect your view. They do not change company data or another membe
1. Select **Theme Settings**.
2. Choose **Light** or **Dark** mode.
3. Under **Assigned Themes** or **Color Themes**, select the intended preset.
+
+
+
4. Close the Theme Settings panel.
**Expected result:** The Portal updates immediately and keeps your selection when you move to another page.
@@ -75,11 +76,14 @@ Open Assets and Administration, then confirm text, controls, tables, and dialogs
Open **Theme Settings** and choose the previous mode and preset.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** Approved Light and Dark screenshots are pending capture and privacy review.
-- **Do it:** Select **Theme Settings** in your WanAware workspace.
+- **In WanAware:** Select **Theme Settings** in your WanAware workspace.
+
+## Next steps
+
+- [Manage your profile and security](https://docs.wanaware.com/docs/manage-profile-and-security)
## Get help
diff --git a/docs/administration-and-personal-settings/create-and-edit-roles.md b/docs/administration-and-personal-settings/create-and-edit-roles.md
index f0aa4c6..b9259e0 100644
--- a/docs/administration-and-personal-settings/create-and-edit-roles.md
+++ b/docs/administration-and-personal-settings/create-and-edit-roles.md
@@ -20,15 +20,13 @@ permission: read roles and create roles; update roles for edits
product-area: Administration and access
content-owner: Product
review-owner: Support
-last-verified: pending
+last-verified: 2026-09-04
last-verified-release: pending
screenshot-set: administration-roles
video-status: not-planned
release-status: draft
-->
-# Create and edit Roles
-
**Outcome:** Create or update a customer Role with the smallest set of Permissions needed for a job.
**For:** Customer administrators
@@ -52,22 +50,28 @@ release-status: draft
| UI label | Purpose | What to enter or select | Where it appears later |
| --- | --- | --- | --- |
-| **Role Name** | Identifies the access profile | A unique, job-based name such as `Asset reviewer` | Role list and member assignment |
+| **Name** | Identifies the access profile | A unique, job-based name such as `Asset reviewer` | Role list and member assignment |
| **Permissions** | Controls visible areas and allowed actions | Only the `action resource` pairs the job requires | The member's navigation and available controls |
| **Create Role** | Saves a new customer Role | Select after reviewing the name and Permissions | Role list |
## Create a Role
1. Open **Administration → IAM → Roles**.
+
+
2. Select **Create Role**.
-3. Enter **Role Name** using a job or responsibility, not a person's name.
+3. Enter **Name** using a job or responsibility, not a person's name.
4. In **Permissions**, expand each product area and select the required actions.
+
+
5. Recheck navigation dependencies. For example, Billing requires all four read permissions listed in [Understand billing](https://docs.wanaware.com/docs/understand-billing).
6. Select **Create Role**.
**Expected result:** The Role opens or appears in the Roles list with the selected Permissions.
-If saving fails, keep the page open, copy the Role Name and selected Permission list, and check for a duplicate name or a permission that your own account cannot assign.
+
+
+If saving fails, keep the page open, copy the **Name** and selected Permission list, and check for a duplicate name or a Permission that your own account cannot assign.
## Edit a customer Role
@@ -86,13 +90,30 @@ Assign the Role to a test member with the intended responsibilities. Have that m
## Undo this change
-Restore the previous Permission list and save again. If the Role is no longer needed, first move assigned members to an approved Role; do not delete a Role while its impact is unknown.
+To reverse a Permission change, restore the previous Permission list and save again.
+
+To remove a customer Role that is no longer needed:
+
+1. Move every assigned member to an approved replacement Role.
+2. Open the unused Role from **Administration → IAM → Roles**.
+3. Select **Delete Role**.
+4. Confirm that the dialog names the intended customer Role and states that deletion cannot be undone.
-## Learn, show me, do it
+
+
+5. Select **Delete**.
+
+**Expected result:** WanAware reports **Role deleted**, returns to the Roles list, and the deleted Role no longer appears. If members still depend on the Role or its impact is unclear, select **Cancel** and review the **Users** tab first.
+
+## Learn and continue
- **Learn:** [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
-- **Show me:** Use the written steps until an IAM recording is approved.
-- **Do it:** Open `/administration/iam/roles` in your WanAware workspace.
+- **In WanAware:** Open `/administration/iam/roles` in your WanAware workspace.
+
+## Next steps
+
+- [Invite users and assign Roles](https://docs.wanaware.com/docs/invite-users-and-assign-roles)
+- [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
## Get help
diff --git a/docs/administration-and-personal-settings/index.md b/docs/administration-and-personal-settings/index.md
index 315db04..6ba0ec0 100644
--- a/docs/administration-and-personal-settings/index.md
+++ b/docs/administration-and-personal-settings/index.md
@@ -15,8 +15,30 @@ metadata:
robots: index
---
-# Administration and personal settings
-
Company administrators manage shared settings, access, and Billing. Each user manages their own profile, security settings, and theme.
-If an action is unavailable, ask an administrator to compare your active Roles with its required Permission. Start with [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
+## Access
+
+- [Invite users and assign Roles](https://docs.wanaware.com/docs/invite-users-and-assign-roles)
+- [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
+- [Create and edit Roles](https://docs.wanaware.com/docs/create-and-edit-roles)
+- [Manage pending invitations](https://docs.wanaware.com/docs/manage-pending-invitations)
+
+## Company and personal settings
+
+- [Manage company settings](https://docs.wanaware.com/docs/manage-company-settings)
+- [Manage your profile and security](https://docs.wanaware.com/docs/manage-profile-and-security)
+- [Choose a theme](https://docs.wanaware.com/docs/choose-a-theme)
+
+## Billing
+
+- [Understand billing, usage, payments, and invoices](https://docs.wanaware.com/docs/understand-billing)
+- [View your plan and usage](https://docs.wanaware.com/docs/view-plan-and-usage)
+- [Manage payment methods](https://docs.wanaware.com/docs/manage-payment-methods)
+- [View billing history and invoices](https://docs.wanaware.com/docs/view-billing-history-and-invoices)
+
+## Fix a problem
+
+- [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions)
+- [I cannot sign in, reset my password, or complete MFA](https://docs.wanaware.com/docs/sign-in-password-and-mfa)
+- [A billing or payment action fails](https://docs.wanaware.com/docs/billing-and-payment-failures)
diff --git a/docs/administration-and-personal-settings/invite-users-and-assign-roles.md b/docs/administration-and-personal-settings/invite-users-and-assign-roles.md
index b656347..8ee72ba 100644
--- a/docs/administration-and-personal-settings/invite-users-and-assign-roles.md
+++ b/docs/administration-and-personal-settings/invite-users-and-assign-roles.md
@@ -8,6 +8,7 @@ metadata:
description: Invite WanAware members, assign roles, and verify their access.
keywords:
- invite user
+ - invite teammate
- IAM
- assign role
- member access
@@ -28,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Invite users and assign roles
-
**Outcome:** Invite a company member and assign the smallest role that supports their work.
**For:** Customer administrators
@@ -66,6 +65,8 @@ release-status: draft
3. Enter the person's business name in **User name**.
4. Enter the exact company address in **Email**.
5. Under **Roles**, select at least one approved Role. If none is selected, the form reports **Select at least one role**.
+
+
6. Review the address and Roles, then select **Create User** once.
**Expected result:** WanAware reports **Invitation sent**, and the member appears with **Invite Status** set to **Pending** until they accept.
@@ -79,7 +80,7 @@ If the email already belongs to a member, update the existing record rather than
3. Ask them to sign in and open one page required for their work.
4. Confirm they do not see unrelated administration actions.
-If the expected page is missing, use [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
+If the expected page is missing, use [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
## Check your result
@@ -89,11 +90,15 @@ The member is active in the correct company, has the intended role, can complete
Do not share an invitation with a different person. If the wrong Role was assigned, correct the existing user record before resending. If the wrong email was invited, stop and contact Support rather than assuming an unverified cancellation or deletion control exists. Before reducing your own administrator access, verify another active administrator can manage IAM.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
-- **Show me:** Use the written steps until an access-management clip is approved.
-- **Do it:** Open `/administration/iam` in your WanAware workspace.
+- **In WanAware:** Open `/administration/iam` in your WanAware workspace.
+
+## Next steps
+
+- [Manage pending invitations](https://docs.wanaware.com/docs/manage-pending-invitations)
+- [Create and edit Roles](https://docs.wanaware.com/docs/create-and-edit-roles)
## Get help
diff --git a/docs/administration-and-personal-settings/manage-company-settings.md b/docs/administration-and-personal-settings/manage-company-settings.md
index a1e32b1..4f225db 100644
--- a/docs/administration-and-personal-settings/manage-company-settings.md
+++ b/docs/administration-and-personal-settings/manage-company-settings.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage company settings
-
**Outcome:** Update an approved company setting and confirm the shared result.
**For:** Customer administrators
@@ -66,6 +64,8 @@ release-status: draft
3. Confirm the company name or identifier.
4. Change only the approved field.
5. Preview logo cropping and contrast before accepting an uploaded image.
+
+
6. Select **Save**.
**Expected result:** WanAware confirms the save and the value remains after refresh.
@@ -80,11 +80,15 @@ Refresh the page and confirm the saved value. Ask a second permitted user to che
Restore the recorded value and save again. Contact Support if the setting has no edit control or its effect cannot be reversed safely.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
-- **Show me:** Use the written steps until a company-settings clip is approved.
-- **Do it:** Open `/administration/general/company` in your WanAware workspace.
+- **In WanAware:** Open `/administration/general/company` in your WanAware workspace.
+
+## Next steps
+
+- [Invite users and assign Roles](https://docs.wanaware.com/docs/invite-users-and-assign-roles)
+- [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
## Get help
diff --git a/docs/administration-and-personal-settings/manage-payment-methods.md b/docs/administration-and-personal-settings/manage-payment-methods.md
index 121f66a..d1e9f21 100644
--- a/docs/administration-and-personal-settings/manage-payment-methods.md
+++ b/docs/administration-and-personal-settings/manage-payment-methods.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage payment methods
-
**Outcome:** Add, update, or remove an authorized payment method and confirm only its masked details are displayed.
**For:** Billing administrators
@@ -76,11 +74,15 @@ Refresh **Payment & Billing**, reopen **View details**, and confirm the expected
Restore the prior billing contact or approved method and verify again. Removing a payment method can affect renewal; do not remove the only method unless the product confirmation and your billing policy permit it.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand billing](https://docs.wanaware.com/docs/understand-billing)
-- **Show me:** Billing visuals require masked test data and privacy approval before publication.
-- **Do it:** Open `/administration/billing` in your WanAware workspace and select **Payment & Billing**.
+- **In WanAware:** Open `/administration/billing` in your WanAware workspace and select **Payment & Billing**.
+
+## Next steps
+
+- [View your plan and usage](https://docs.wanaware.com/docs/view-plan-and-usage)
+- [View billing history and invoices](https://docs.wanaware.com/docs/view-billing-history-and-invoices)
## Get help
diff --git a/docs/administration-and-personal-settings/manage-pending-invitations.md b/docs/administration-and-personal-settings/manage-pending-invitations.md
index 2e40943..37d1346 100644
--- a/docs/administration-and-personal-settings/manage-pending-invitations.md
+++ b/docs/administration-and-personal-settings/manage-pending-invitations.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage pending invitations
-
**Outcome:** Confirm whether a member accepted an invitation and resend the existing invitation when it remains Pending.
**For:** Customer administrators
@@ -74,11 +72,15 @@ Ask the member to open the newest email and complete the invitation. Refresh the
A sent email cannot be recalled. If the address or Role is wrong, do not forward the invitation; contact Support with the member email and timestamp so the access path can be reviewed safely.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
-- **Show me:** Use the written steps until an IAM recording is approved.
-- **Do it:** Open `/administration/iam` in your WanAware workspace.
+- **In WanAware:** Open `/administration/iam` in your WanAware workspace.
+
+## Next steps
+
+- [Invite users and assign Roles](https://docs.wanaware.com/docs/invite-users-and-assign-roles)
+- [Fix sign-in, password, or MFA problems](https://docs.wanaware.com/docs/sign-in-password-and-mfa)
## Get help
diff --git a/docs/administration-and-personal-settings/manage-profile-and-security.md b/docs/administration-and-personal-settings/manage-profile-and-security.md
index b18fc20..dd9a867 100644
--- a/docs/administration-and-personal-settings/manage-profile-and-security.md
+++ b/docs/administration-and-personal-settings/manage-profile-and-security.md
@@ -28,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage your profile and security
-
**Outcome:** Update a personal profile or security setting and verify that your account remains accessible.
**For:** Signed-in WanAware members
@@ -73,6 +71,8 @@ release-status: draft
2. Select **General**.
3. Change **Full Name**, **Timezone**, the time format, or the date format.
4. To change your avatar, select **Change avatar** and choose a supported image no larger than 1 MB.
+
+
5. Select **Save**.
**Expected result:** WanAware displays **Profile updated successfully**.
@@ -89,6 +89,8 @@ This option appears only when WanAware manages your password.
1. Open your profile menu and select **Security**.
2. In **Change Password**, enter your **Current Password**.
+
+
3. Enter a **New Password** with at least 12 characters.
4. Include at least one uppercase letter, one lowercase letter, one digit, and one special character.
5. Enter the same value in **Confirm New Password**.
@@ -152,7 +154,7 @@ If **Disable** is unavailable, your organization requires MFA. Ask an administra
Open a private browser session and sign in with the updated password or authenticator. Keep the original session open until this test succeeds.
-If the new sign-in fails, return to the original session and review [Sign-in, password, and MFA problems](https://docs.wanaware.com/docs/sign-in-password-and-mfa).
+If the new sign-in fails, return to the original session and review [I cannot sign in, reset my password, or complete MFA](https://docs.wanaware.com/docs/sign-in-password-and-mfa).
## Undo this change
@@ -160,11 +162,15 @@ Restore an editable profile value through **General**.
You cannot recover a previous password or recovery-code set. If you lose every working sign-in method, contact Support from a trusted company address.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Roles and Permissions](https://docs.wanaware.com/docs/understand-roles-and-permissions)
-- **Show me:** Use the written steps until a profile clip is approved.
-- **Do it:** Open `/profile/general` or `/profile/security` in your WanAware workspace.
+- **In WanAware:** Open `/profile/general` or `/profile/security` in your WanAware workspace.
+
+## Next steps
+
+- [Choose a theme](https://docs.wanaware.com/docs/choose-a-theme)
+- [Fix sign-in, password, or MFA problems](https://docs.wanaware.com/docs/sign-in-password-and-mfa)
## Get help
diff --git a/docs/administration-and-personal-settings/understand-billing.md b/docs/administration-and-personal-settings/understand-billing.md
index eaca5f9..0c7fd04 100644
--- a/docs/administration-and-personal-settings/understand-billing.md
+++ b/docs/administration-and-personal-settings/understand-billing.md
@@ -29,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Understand billing, usage, payments, and invoices
-
The Billing area separates subscription information from payment details and historical invoices. Prices, limits, and renewal terms are account-specific; use the values shown in your workspace as the authority.
## Why Billing is missing
diff --git a/docs/administration-and-personal-settings/understand-roles-and-permissions.md b/docs/administration-and-personal-settings/understand-roles-and-permissions.md
index 2f86d02..ab65f86 100644
--- a/docs/administration-and-personal-settings/understand-roles-and-permissions.md
+++ b/docs/administration-and-personal-settings/understand-roles-and-permissions.md
@@ -28,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Understand Roles and Permissions
-
A role is a named set of permissions. Permissions can control whether a member sees a product area and whether they can create, view, update, delete, publish, or attach records in that area.
This means two members in the same company can have different navigation and actions. A missing button is often an access question, not a display failure.
@@ -50,7 +48,13 @@ This means two members in the same company can have different navigation and act
4. Ask an administrator to review the role's relevant permission.
5. Sign out and back in after an approved role change.
-Use [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions) for a full recovery path.
+Use [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions) for a full recovery path.
+
+## Related tasks
+
+- [Create and edit Roles](https://docs.wanaware.com/docs/create-and-edit-roles)
+- [Invite users and assign Roles](https://docs.wanaware.com/docs/invite-users-and-assign-roles)
+- [Manage pending invitations](https://docs.wanaware.com/docs/manage-pending-invitations)
## Get help
diff --git a/docs/administration-and-personal-settings/view-billing-history-and-invoices.md b/docs/administration-and-personal-settings/view-billing-history-and-invoices.md
index 04746d9..9cdb16f 100644
--- a/docs/administration-and-personal-settings/view-billing-history-and-invoices.md
+++ b/docs/administration-and-personal-settings/view-billing-history-and-invoices.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# View billing history and invoices
-
**Outcome:** Locate a billing-history entry and open the associated invoice for an authorized business purpose.
**For:** Billing administrators
@@ -66,11 +64,15 @@ Invoices can contain private company and billing information. Follow your compan
Match the invoice date and amount to the **Billing History** row you selected. If the row exists but the invoice is missing or mismatched, record the row values and timestamp without sending the full document.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand billing](https://docs.wanaware.com/docs/understand-billing)
-- **Show me:** Billing visuals require masked test data and privacy approval before publication.
-- **Do it:** Open `/administration/billing` in your WanAware workspace and select **Billing History**.
+- **In WanAware:** Open `/administration/billing` in your WanAware workspace and select **Billing History**.
+
+## Next steps
+
+- [View your plan and usage](https://docs.wanaware.com/docs/view-plan-and-usage)
+- [Fix a billing or payment action](https://docs.wanaware.com/docs/billing-and-payment-failures)
## Get help
diff --git a/docs/administration-and-personal-settings/view-plan-and-usage.md b/docs/administration-and-personal-settings/view-plan-and-usage.md
index decfdfc..99a2b97 100644
--- a/docs/administration-and-personal-settings/view-plan-and-usage.md
+++ b/docs/administration-and-personal-settings/view-plan-and-usage.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# View your plan and usage
-
**Outcome:** Identify the current plan and the Asset usage shown for the company without changing the subscription.
**For:** Customer administrators and billing administrators
@@ -69,11 +67,15 @@ Use the plan, quota, and renewal values displayed in your own workspace. Documen
Refresh **Plans** and confirm the same plan and usage return. If usage differs from Inventory, record both counts and the time zone; background processing can make observations taken at different times hard to compare.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand billing](https://docs.wanaware.com/docs/understand-billing)
-- **Show me:** Billing visuals require masked test data and privacy approval before publication.
-- **Do it:** Open `/administration/billing` in your WanAware workspace and select **Plans**.
+- **In WanAware:** Open `/administration/billing` in your WanAware workspace and select **Plans**.
+
+## Next steps
+
+- [Manage payment methods](https://docs.wanaware.com/docs/manage-payment-methods)
+- [View billing history and invoices](https://docs.wanaware.com/docs/view-billing-history-and-invoices)
## Get help
diff --git a/docs/asset-types-and-service-catalog/add-catalog-entries-and-compatibility.md b/docs/asset-types-and-service-catalog/add-catalog-entries-and-compatibility.md
index 200e671..350574d 100644
--- a/docs/asset-types-and-service-catalog/add-catalog-entries-and-compatibility.md
+++ b/docs/asset-types-and-service-catalog/add-catalog-entries-and-compatibility.md
@@ -29,8 +29,6 @@ video-status: planned
release-status: draft
-->
-# Add catalog entries and compatibility
-
**Outcome:** Build the managed choices needed by a draft Asset Type and verify their compatibility relationships.
**For:** Customer administrators and data model owners
@@ -69,9 +67,12 @@ release-status: draft
3. Choose an available top-level type such as **Manufacturer**, **Provider**, **Carrier**, or **Carrier Loop**.
4. Enter its name, description, and approved custom data.
5. Save the entry.
-6. Select the appropriate parent, then add **Model** where supported.
+6. Select the saved **Provider** or **Manufacturer** that owns the product, then add **Model** if that parent exposes the action.
7. Under the required manufacturer context, add **Module** or **Software** where supported.
8. Add the available specifications and catalog attributes.
+
+
+
9. Save after each coherent group of changes.
**Expected result:** The hierarchy shows each entry under the intended parent with its saved details.
@@ -96,11 +97,10 @@ Use a documentation-only asset after the catalog is saved. Select the parent cat
Remove an incorrect compatibility selection and save again. Before editing or removing a catalog record, confirm whether it is used by any asset or dependent entry.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The compatibility clip is pending workflow verification and approval.
-- **Do it:** Open `/administration/service-catalog` and select the draft Asset Type.
+- **In WanAware:** Open `/administration/service-catalog` and select the draft Asset Type.
## Next steps
diff --git a/docs/asset-types-and-service-catalog/bulk-upload-service-catalog-entries.md b/docs/asset-types-and-service-catalog/bulk-upload-service-catalog-entries.md
index 26d50fa..23c5f7a 100644
--- a/docs/asset-types-and-service-catalog/bulk-upload-service-catalog-entries.md
+++ b/docs/asset-types-and-service-catalog/bulk-upload-service-catalog-entries.md
@@ -2,7 +2,7 @@
title: Bulk upload Service Catalog entries
excerpt: Map columns, resolve conflicts and errors, create catalog entries, and reconcile a bulk-upload job.
deprecated: false
-hidden: false
+hidden: true
metadata:
title: Bulk upload Service Catalog entries | WanAware Documentation
description: Validate and create Service Catalog providers, models, or services from a file or pasted spreadsheet.
@@ -11,7 +11,7 @@ metadata:
- catalog conflict
- create catalog entries
- existing provider id
- robots: index
+ robots: noindex
---
-# Bulk upload Service Catalog entries
-
-> **Publication blocker:** The released UI and field contract have been reviewed, but the current release-equivalent verification workspace reports **Catalog bulk upload is not connected in this environment.** This draft must not be marked ready until a full job succeeds and Product and Support approve the results.
-
**Outcome:** Validate a prepared file, resolve mapping and row issues, create accepted catalog entries, and verify the final hierarchy.
**For:** Customer administrators and data model owners
@@ -59,21 +55,31 @@ release-status: draft
## Field and option guide
-| UI label or result | Purpose | Required state or accepted format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **CSV or XLSX** | Uploads a saved spreadsheet file. | Current template; maximum 100 MB. | Prepared local file. | `catalog-import.xlsx` | Mapping and job summary. |
-| **Paste spreadsheet** | Accepts a copied tabular range. | Include one header row and a rectangular data range. | Spreadsheet clipboard. | Header plus 10 rows | Mapping and validation. |
-| Column mapping | Connects source headers to catalog fields. | Map required fields once; choose **Ignore** for unrelated columns. | File headers and current schema. | `Provider Name` → Provider name | Entry fields. |
-| **Ready** | Entry has no blocking issue. | Review the final name and description. | Validation result. | — | Eligible for creation. |
-| **Conflicts** | Entry collides with existing or submitted data. | Resolve the named identity or parent conflict. | Validation result. | Duplicate provider name | Blocks affected entry. |
-| **Errors** | Entry violates a required format or relationship. | Correct the named field and revalidate. | Validation result. | Unknown provider ID | Blocks affected entry. |
-| Editable name and description | Corrects a reviewed entry before creation. | Use approved customer-facing text. | Data owner. | Corrected model name | Catalog entry. |
-| **Create N entries** | Submits the currently accepted set. | `N` must match the reviewed count. | Review summary. | Create 12 entries | Processing job. |
+### Provide the data
+
+| Choice | Accepted input | What appears next |
+| --- | --- | --- |
+| **CSV or XLSX** | A current template file up to 100 MB, such as `catalog-import.xlsx`. | Column mapping and the job summary. |
+| **Paste spreadsheet** | One header row and a rectangular copied range. | Column mapping and validation. |
+| Column mapping | Map each required header to one catalog field; choose **Ignore** for unrelated columns. | Mapped values in the entry review. |
+
+### Review the results
+
+| Result or action | What it means | What to do next |
+| --- | --- | --- |
+| **Ready** | The entry has no blocking issue. | Review its final name and description. |
+| **Conflicts** | The entry collides with existing or submitted data. | Resolve the named identity or parent conflict. |
+| **Errors** | A required format or relationship failed. | Correct the named field and revalidate. |
+| Editable name and description | The reviewed entry can still be corrected. | Enter approved customer-facing text, then revalidate. |
+| **Create N entries** | Submits the accepted set shown in the summary. | Confirm that `N` matches the reviewed count before selecting it. |
## Upload and map the data
1. Open the bulk-upload page for the selected Asset Type and writable catalog.
2. Choose the correct option under **What are you adding?**
+
+
+
3. Choose **CSV or XLSX** and select a file no larger than 100 MB, or choose **Paste spreadsheet** and paste the header plus data rows.
4. Select **Upload & validate**.
5. Review the automatic column mapping.
@@ -116,16 +122,15 @@ If the outcome is partial, do not resubmit the entire source. Build a retry set
- For an uncertain result, search the catalog by stable parent and entry identity before retrying.
- To remove or correct a created entry, first check dependent Asset Types, catalog children, compatibility, and Assets; use only a released edit or delete action approved for that entry.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Prepare a Service Catalog bulk-upload file](https://docs.wanaware.com/docs/prepare-a-service-catalog-bulk-upload-file)
-- **Show me:** This video remains blocked until the complete workflow succeeds in a release-equivalent environment.
-- **Do it:** Open `/administration/service-catalog/{assetTypeId}/bulk-upload`.
+- **In WanAware:** Open `/administration/service-catalog/{assetTypeId}/bulk-upload`.
## Next steps
- [Publish and verify an Asset Type](https://docs.wanaware.com/docs/publish-and-verify-an-asset-type)
-- [Service Catalog failures](https://docs.wanaware.com/docs/service-catalog-failures)
+- [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures)
## Get help
diff --git a/docs/asset-types-and-service-catalog/configure-asset-type-sections-and-fields.md b/docs/asset-types-and-service-catalog/configure-asset-type-sections-and-fields.md
index a1fa86f..3eee641 100644
--- a/docs/asset-types-and-service-catalog/configure-asset-type-sections-and-fields.md
+++ b/docs/asset-types-and-service-catalog/configure-asset-type-sections-and-fields.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Configure Asset Type sections and fields
-
**Outcome:** Build a draft Asset Type that collects the right information in a clear order.
**For:** Customer administrators and data model owners
@@ -87,6 +85,8 @@ release-status: draft
**Expected result:** The saved draft reopens with the intended sections, field order, dependencies, and catalog support.
+
+
If a dependent field has no valid parent or a required setting conflicts with the input type, correct the field before continuing. Do not publish to test an unfinished configuration.
## Check your result
@@ -97,11 +97,10 @@ Reopen the draft and verify every section and field. Then open **Administration
While the Asset Type is a draft, restore the previous setting or remove an unused field after confirming no test data depends on it. After publication, schema editing may be unavailable; contact Support before attempting a replacement strategy.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The field-builder clip is pending workflow verification and approval.
-- **Do it:** Open **Administration → Asset Types** (`/administration/asset-types`) and select a draft Asset Type.
+- **In WanAware:** Open **Administration → Asset Types** (`/administration/asset-types`) and select a draft Asset Type.
## Next steps
diff --git a/docs/asset-types-and-service-catalog/create-a-custom-asset-type.md b/docs/asset-types-and-service-catalog/create-a-custom-asset-type.md
index e3973fe..d1373bd 100644
--- a/docs/asset-types-and-service-catalog/create-a-custom-asset-type.md
+++ b/docs/asset-types-and-service-catalog/create-a-custom-asset-type.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Create a custom Asset Type
-
**Outcome:** Create a named custom Asset Type and save it as a draft for further configuration.
**For:** Customer administrators and data model owners
@@ -87,6 +85,8 @@ All three paths create a custom draft. The difference is how the first set of se
**Expected result:** The Asset Type appears in the list with **Draft** status.
+
+
If generation fails or produces unsuitable fields, return to the starting options or remove the unwanted draft fields before saving. Do not publish unreviewed generated content.
## Check your result
@@ -95,16 +95,40 @@ If generation fails or produces unsuitable fields, return to the starting option
2. Search for the exact name.
3. Confirm the status is **Draft**.
4. Reopen it and verify the name and description.
+5. Open the row actions menu and confirm the actions match the Asset Type's status and your permissions. A manageable draft can show **Edit asset type** and **Publish asset type**; a published customer type shows **View asset type** instead.
+
+
+
+### What the row actions do
+
+| Action | Permission | Result |
+| --- | --- | --- |
+| **View asset type** or **Edit asset type** | `view asset_types_builder` or `update asset_types_builder` | Opens the selected schema. Published customer schemas can be view-only. |
+| **Open in new tab** | Same access as View or Edit | Opens the same Asset Type without closing the list. |
+| **Clone asset type** | `create asset_types_builder` | Creates a named custom draft from the selected schema. |
+| **Publish asset type** | `update asset_types_builder` | Starts the publication preflight for an unpublished manageable type. Review the read-only consequence before confirming. |
+| **Hide asset type** or **Restore asset type** | `update asset_types_builder` | Changes customer visibility without deleting the schema. |
+| **Copy name** or **Copy ID** | Access to the Asset Type list | Copies the displayed identity for search or Support. |
+| **Delete asset type** | `delete asset_types_builder` | Opens an impact check and confirmation. Do not continue until affected Assets and dependencies are understood. |
## Undo this change
-Delete only an unused draft after confirming it has no catalog entries or test assets. Do not use deletion to revise a field; edit the draft instead.
+Delete only an unused draft after confirming it has no catalog entries or test Assets. Do not use deletion to revise a field; edit the draft instead.
+
+1. Return to **Administration → Asset Types**.
+2. Search for the draft by its exact name.
+3. Open the row actions menu and select **Delete asset type**.
+4. Wait for the usage check. Continue only when no Assets or dependent catalog data use the draft.
+5. Read the permanent-deletion warning and select **Delete** only when the displayed Asset Type is the intended unused draft.
+
+
+
+**Expected result:** The draft no longer appears after the list refreshes. If the usage check reports dependencies, cancel the deletion and remove or correct those dependencies before trying again.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The starting-options clip is pending workflow verification and approval.
-- **Do it:** Open `/administration/asset-types/create` in your WanAware workspace.
+- **In WanAware:** Open `/administration/asset-types/create` in your WanAware workspace.
## Next steps
diff --git a/docs/asset-types-and-service-catalog/create-a-custom-service-catalog.md b/docs/asset-types-and-service-catalog/create-a-custom-service-catalog.md
index 4cbdac8..b5a74b9 100644
--- a/docs/asset-types-and-service-catalog/create-a-custom-service-catalog.md
+++ b/docs/asset-types-and-service-catalog/create-a-custom-service-catalog.md
@@ -8,6 +8,7 @@ metadata:
description: Create and save Service Catalog data for a draft custom WanAware Asset Type.
keywords:
- create Service Catalog
+ - create catalog
- custom catalog
- draft Asset Type catalog
robots: index
@@ -27,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Create a custom Service Catalog
-
**Outcome:** Select a draft custom Asset Type, add an approved catalog entry, and save the catalog.
**For:** Customer administrators and data model owners
@@ -65,10 +64,16 @@ release-status: draft
1. Open **Administration → Service Catalog**.
2. Use the catalog selector to choose the draft custom Asset Type.
3. Confirm the selected type is the intended draft.
+
+
+
4. Select **Add**.
5. Choose the entry type required by the schema.
6. Enter the canonical name and description.
7. Add only approved specifications or attributes.
+
+
+
8. Select **Save**.
**Expected result:** The entry appears in the selected Asset Type's catalog after a refresh.
@@ -86,11 +91,10 @@ If the Asset Type is unavailable, confirm that it was saved as a customer draft
Edit or remove an unused custom entry only while the draft lifecycle permits it and after checking dependencies and compatibility. Do not remove an entry already selected by test or customer assets without an impact review.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The first-entry clip is pending workflow verification and approval.
-- **Do it:** Open `/administration/service-catalog` in your WanAware workspace.
+- **In WanAware:** Open `/administration/service-catalog` in your WanAware workspace.
## Next steps
diff --git a/docs/asset-types-and-service-catalog/index.md b/docs/asset-types-and-service-catalog/index.md
index 4bee255..4e384b9 100644
--- a/docs/asset-types-and-service-catalog/index.md
+++ b/docs/asset-types-and-service-catalog/index.md
@@ -13,8 +13,27 @@ metadata:
robots: index
---
-# Asset Types and Service Catalog
-
An **Asset Type** defines an asset's sections, fields, and dependencies. Its **Service Catalog** provides managed choices such as manufacturers, models, components, software, specifications, attributes, and compatibility.
Keep a custom Asset Type as a draft while you configure its schema and catalog. Publish only after both are ready, because publishing can make the custom schema read-only.
+
+## Learn
+
+- [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
+
+## Set up an Asset Type
+
+1. [Create a custom Asset Type](https://docs.wanaware.com/docs/create-a-custom-asset-type).
+2. [Configure its sections and fields](https://docs.wanaware.com/docs/configure-asset-type-sections-and-fields).
+3. Configure the Service Catalog while the Asset Type remains a draft.
+4. [Publish and verify the Asset Type](https://docs.wanaware.com/docs/publish-and-verify-an-asset-type).
+
+## Manage the Service Catalog
+
+- [Create a custom Service Catalog](https://docs.wanaware.com/docs/create-a-custom-service-catalog)
+- [Add catalog entries and compatibility](https://docs.wanaware.com/docs/add-catalog-entries-and-compatibility)
+
+## Fix a problem
+
+- [An Asset Type does not save or publish](https://docs.wanaware.com/docs/asset-type-save-or-publish-failures)
+- [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures)
diff --git a/docs/asset-types-and-service-catalog/prepare-a-service-catalog-bulk-upload-file.md b/docs/asset-types-and-service-catalog/prepare-a-service-catalog-bulk-upload-file.md
index 4583c8c..ae4e129 100644
--- a/docs/asset-types-and-service-catalog/prepare-a-service-catalog-bulk-upload-file.md
+++ b/docs/asset-types-and-service-catalog/prepare-a-service-catalog-bulk-upload-file.md
@@ -2,7 +2,7 @@
title: Prepare a Service Catalog bulk-upload file
excerpt: Choose the correct import type and prepare current template data for catalog validation.
deprecated: false
-hidden: false
+hidden: true
metadata:
title: Prepare a Service Catalog bulk-upload file | WanAware Documentation
description: Prepare a CSV, XLSX, or pasted spreadsheet for the Service Catalog bulk uploader.
@@ -10,7 +10,7 @@ metadata:
- service catalog template
- existing provider id
- catalog spreadsheet
- robots: index
+ robots: noindex
---
-# Prepare a Service Catalog bulk-upload file
-
**Outcome:** Produce a current, correctly scoped spreadsheet that is ready for column mapping and entry validation.
**For:** Customer administrators and data model owners
@@ -55,16 +53,25 @@ release-status: draft
## Field and option guide
-| UI label or column | Purpose | Required state or accepted format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **New providers with models or services** | Creates new parent providers and their child rows. | Choose when the provider does not exist in this catalog. | Catalog review. | New provider plus two models | Provider and child hierarchy. |
-| **Models or services for existing providers** | Adds children beneath an existing provider. | Choose when a provider record already exists. | Current catalog. | Two services for one provider ID | Existing provider hierarchy. |
-| Provider name | Names a new provider. | Required for new-provider rows; use the approved display name. | Approved source list. | Example Networks | Catalog picker. |
-| Existing provider ID | Identifies the exact parent for child-only rows. | Required for existing-provider imports; copy the stable ID, not the name. | Existing Service Catalog entry. | `provider-id-from-catalog` | Parent linkage after creation. |
-| Model or service name | Names the child entry. | Non-empty, consistent spelling; one logical item per row. | Approved source list. | Edge 1000 | Child entry and Asset choices. |
-| Description | Explains the entry for users choosing it. | Plain language; no credentials or sensitive data. | Product or data owner. | Branch edge appliance | Entry details. |
-| Specifications or attributes | Supplies supported structured values. | Match the downloaded template's columns and format. | Approved technical data. | Throughput tier | Catalog details and supported Asset fields. |
-| Compatibility | Relates supported catalog choices. | Use identifiers or choices required by the current template. | Approved compatibility matrix. | Supported module | Dependent catalog choices. |
+### Choose the import type
+
+| Choice | Use it when | Result |
+| --- | --- | --- |
+| **New providers with models or services** | The provider does not exist in the selected catalog. | Creates the provider and its child rows. |
+| **Models or services for existing providers** | The provider already exists in the selected catalog. | Adds children beneath the provider identified in the file. |
+
+### Prepare the columns
+
+| Column | Required value | Where it comes from |
+| --- | --- | --- |
+| Provider name | Required for new-provider rows. Use the approved display name, such as Example Networks. | Approved source list. |
+| Existing provider ID | Required for existing-provider imports. Copy the stable ID, not the display name. | Existing Service Catalog entry. |
+| Model or service name | Enter one non-empty, consistently spelled child item per row, such as Edge 1000. | Approved source list. |
+| Description | Write plain-language selection help without credentials or sensitive data. | Product or data owner. |
+| Specifications or attributes | Match the columns and format in the template downloaded for this run. | Approved technical data. |
+| Compatibility | Use the identifiers or choices required by the current template. | Approved compatibility matrix. |
+
+These values appear in the provider hierarchy, catalog picker, entry details, dependent choices, and supported Asset fields after creation.
## Choose the import type and template
@@ -74,6 +81,9 @@ release-status: draft
4. Under **What are you adding?**, choose:
- **New providers with models or services** when the spreadsheet creates parent providers.
- **Models or services for existing providers** when every child row belongs to an existing provider ID.
+
+
+
5. Select **Download template** for the chosen import type.
**Expected result:** The downloaded template matches both the selected catalog and import type.
@@ -106,16 +116,15 @@ For **Paste spreadsheet**, copy a rectangular range including the header row. Do
Delete or archive the local prepared file according to your data-handling policy. No Service Catalog record is created until the later **Create N entries** action.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** This clip requires successful end-to-end service verification before publication.
-- **Do it:** Open `/administration/service-catalog/{assetTypeId}/bulk-upload`.
+- **In WanAware:** Open `/administration/service-catalog/{assetTypeId}/bulk-upload`.
## Next steps
- [Bulk upload Service Catalog entries](https://docs.wanaware.com/docs/bulk-upload-service-catalog-entries)
-- [Service Catalog failures](https://docs.wanaware.com/docs/service-catalog-failures)
+- [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures)
## Get help
diff --git a/docs/asset-types-and-service-catalog/publish-and-verify-an-asset-type.md b/docs/asset-types-and-service-catalog/publish-and-verify-an-asset-type.md
index ae29ad4..8396938 100644
--- a/docs/asset-types-and-service-catalog/publish-and-verify-an-asset-type.md
+++ b/docs/asset-types-and-service-catalog/publish-and-verify-an-asset-type.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Publish and verify an Asset Type
-
**Outcome:** Publish an approved custom Asset Type and confirm that its fields and catalog choices work on an asset.
**For:** Customer administrators and data model owners
@@ -66,11 +64,13 @@ release-status: draft
4. Confirm catalog-backed fields have usable values in **Service Catalog**.
5. Select **Publish**.
6. Read the confirmation, including the read-only consequence.
+
+
7. Confirm publication only when the configuration is approved.
**Expected result:** The Asset Type appears with **Published** status.
-If publication fails, do not create a replacement. Use [Asset Type save or publish failures](https://docs.wanaware.com/docs/asset-type-save-or-publish-failures).
+If publication fails, do not create a replacement. Use [An Asset Type does not save or publish](https://docs.wanaware.com/docs/asset-type-save-or-publish-failures).
## Verify with an asset
@@ -89,16 +89,15 @@ Ask a member with `read assets` to open the test Asset. Confirm that the member
Publication may not be reversible through the customer interface. Do not delete a published Asset Type or its test assets to simulate an undo. Contact Support with the Asset Type ID if the published schema is wrong.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The publication and Asset verification clip is pending workflow verification and approval.
-- **Do it:** Open **Administration → Asset Types** (`/administration/asset-types`).
+- **In WanAware:** Open **Administration → Asset Types** (`/administration/asset-types`).
## Next steps
- [Populate asset details](https://docs.wanaware.com/docs/populate-asset-details)
-- [Service Catalog failures](https://docs.wanaware.com/docs/service-catalog-failures)
+- [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures)
## Get help
diff --git a/docs/asset-types-and-service-catalog/understand-asset-types-and-service-catalogs.md b/docs/asset-types-and-service-catalog/understand-asset-types-and-service-catalogs.md
index 89c3fa5..967297e 100644
--- a/docs/asset-types-and-service-catalog/understand-asset-types-and-service-catalogs.md
+++ b/docs/asset-types-and-service-catalog/understand-asset-types-and-service-catalogs.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Understand Asset Types and Service Catalogs
-
An **Asset Type** defines the structure of an asset record: its sections, fields, dependencies, and whether a field uses managed catalog data. A **Service Catalog** provides those managed choices and their relationships.
@@ -63,6 +61,14 @@ Start with the fields needed for one real workflow. Use familiar names and assig
Before publication, test the draft with non-customer sample data.
+## Related tasks
+
+- [Create a custom Asset Type](https://docs.wanaware.com/docs/create-a-custom-asset-type)
+- [Configure Asset Type sections and fields](https://docs.wanaware.com/docs/configure-asset-type-sections-and-fields)
+- [Create a custom Service Catalog](https://docs.wanaware.com/docs/create-a-custom-service-catalog)
+- [Add catalog entries and compatibility](https://docs.wanaware.com/docs/add-catalog-entries-and-compatibility)
+- [Publish and verify an Asset Type](https://docs.wanaware.com/docs/publish-and-verify-an-asset-type)
+
## Get help
Email [support@wanaware.com](mailto:support@wanaware.com?subject=WanAware%20Asset%20model%20question) and include:
diff --git a/docs/assets-and-relationships/add-a-network-connection.md b/docs/assets-and-relationships/add-a-network-connection.md
index 5bfe926..c9f103c 100644
--- a/docs/assets-and-relationships/add-a-network-connection.md
+++ b/docs/assets-and-relationships/add-a-network-connection.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Add a supported network connection
-
**Outcome:** Connect two supported network Assets through **Add Connection** and verify the Relationship.
@@ -104,16 +102,15 @@ Use the **Remove Connection** action only after confirming the affected Relation
If **Remove Connection** is absent, contact Support before changing an endpoint or shared IP block.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Relationship Discovery Engine](https://docs.wanaware.com/docs/relationship-discovery-engine)
-- **Show me:** The connection preview clip is pending workflow verification and approval.
-- **Do it:** Open a supported Asset in **Functions → Assets → Inventory** (`/assets/inventory`) and select **Add Connection**.
+- **In WanAware:** Open a supported Asset in **Functions → Assets → Inventory** (`/assets/inventory`) and select **Add Connection**.
## Next steps
- [View asset relationships](https://docs.wanaware.com/docs/view-asset-relationships)
-- [Missing or unexpected relationships](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
+- [A Relationship is missing or unexpected](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
## Get help
diff --git a/docs/assets-and-relationships/add-an-asset.md b/docs/assets-and-relationships/add-an-asset.md
index a0b3b9f..b51ea7f 100644
--- a/docs/assets-and-relationships/add-an-asset.md
+++ b/docs/assets-and-relationships/add-an-asset.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Add an Asset
-
**Outcome:** Create one Asset in the intended workspace and reopen it to confirm the saved values.
**For:** Customer administrators and engineers
@@ -52,14 +50,27 @@ release-status: draft
## Field and option guide
-| UI label | Purpose | Required state or format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **Asset Type** | Selects the schema and icon for the Asset. | Required; choose one existing type. | Your data model or administrator. | Router | Asset header, Inventory Type column, and detail tabs. |
-| **Status** | Chooses the initial workspace. | Required; **Inventory** or **Discovery**. | Your review process. | Discovery | The matching Assets tab. |
-| **Asset Name** | Gives the record its searchable identity. | Required; use a durable, unique name. | Approved inventory or source system. | edge-router-01 | Search, tables, Map, Graph, and Relationship Graph. |
-| **Data Tags** | Adds descriptive labels for searching and filtering. | Optional; use an agreed `key:value` or team naming convention. | Your tagging standard. | environment:production | Asset details and supported filters. |
-| **Structure Tags** | Attaches the Asset to a supported Structure node. | Optional; select an existing Structure Tag. | **Functions → Structures**. | East Region | Asset details and Structure context. |
-| Type-specific fields | Stores details defined by the Asset Type. | Complete every required field; formats and choices come from the schema. | Source records, approved owner, or Service Catalog. | Serial number or model | Schema-specific detail tabs. |
+### Information you need
+
+| UI label | What to enter or choose | Where the value comes from |
+| --- | --- | --- |
+| **Asset Type** | Required. Choose the existing type that defines the Asset's fields and icon. | Your data model or administrator. |
+| **Status** | Required. Choose **Inventory** for a maintained Asset or **Discovery** for a record that still needs review. | Your team's review process. |
+| **Asset Name** | Required. Enter a durable name that distinguishes this Asset from similar records. | Approved inventory or source system. |
+| **Data Tags** | Optional. Add searchable labels using your team's naming convention. | Your tagging standard. |
+| **Structure Tags** | Optional. Select an existing Structure Tag that places the Asset in the intended hierarchy. | **Functions → Structures**. |
+| Type-specific fields | Complete every field marked required. Formats and choices come from the selected Asset Type. | Source records, the accountable owner, or a Service Catalog. |
+
+### What happens next
+
+| UI label | Example | Where it appears after saving |
+| --- | --- | --- |
+| **Asset Type** | Router | Asset header, Type column, and detail tabs. |
+| **Status** | Discovery | The matching **Discovery** or **Inventory** tab. |
+| **Asset Name** | `edge-router-01` | Search, Table, Map, Graph, and Relationship Graph. |
+| **Data Tags** | `environment:production` | Asset details and supported filters. |
+| **Structure Tags** | East Region | Asset details and Structure context. |
+| Type-specific fields | Serial number or model | Asset Type-specific detail tabs. |
## Create the Asset
@@ -80,7 +91,7 @@ The List view shows the same Asset Types and selection in a denser layout. Switc
6. Add approved **Data Tags** and **Structure Tags**. Do not create a new spelling of an existing tag.
7. Complete the required type-specific fields. For a catalog-backed field, select an existing catalog entry rather than typing a near-duplicate.
-
+
After the type is selected, confirm the **Selected Type** summary before entering data. In this example, **Manufacturer** and **Model** are catalog-backed choices, while **OS Version**, **Firmware Version**, **Serial Number**, and **Switch Name** are fields supplied by the Asset Type. Your fields can differ because administrators configure each Asset Type.
@@ -88,6 +99,8 @@ After the type is selected, confirm the **Selected Type** summary before enterin
**Expected result:** WanAware displays **Asset Added!** and identifies whether the record was added to Inventory or Discovery.
+
+
If the save fails, keep the form open, record the exact error, and correct only the named field. If no field is named, copy the non-secret values before refreshing so you can retry without guessing.
9. Select **View Asset** to inspect the record, **Add Another** to keep the same workflow open, or **Done** to close it.
@@ -104,11 +117,10 @@ If the save fails, keep the form open, record the exact error, and correct only
Correct an editable value and save again. If the record should not exist, follow [Delete Assets safely](https://docs.wanaware.com/docs/delete-assets-safely) after checking Relationships, Structure Tags, and Collection membership. Do not delete a record merely to change a field.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Add or import Assets](https://docs.wanaware.com/docs/add-or-import-assets)
-- **Show me:** The add-or-import clip is pending Product and Support review.
-- **Do it:** Open `/assets/inventory`, then select **+ Add Asset → Add Manual Asset**.
+- **In WanAware:** Open `/assets/inventory`, then select **+ Add Asset → Add Manual Asset**.
## Next steps
diff --git a/docs/assets-and-relationships/add-or-import-assets.md b/docs/assets-and-relationships/add-or-import-assets.md
index e69c7c3..8837461 100644
--- a/docs/assets-and-relationships/add-or-import-assets.md
+++ b/docs/assets-and-relationships/add-or-import-assets.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Add or import Assets
-
Choose the workflow that matches the number of Assets and the source of truth. Both paths require `create assets`.
@@ -45,11 +43,10 @@ Use manual creation for a small number of records or a one-off correction. Use b
Regardless of path, search first. A matching display name is not enough to prove two records are different; compare Asset Type, source, and stable identifiers.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The captioned add-or-import clip is pending workflow verification and approval.
-- **Do it:** Open `/assets/inventory`, then select **+ Add Asset**.
+- **In WanAware:** Open `/assets/inventory`, then select **+ Add Asset**.
## Next steps
diff --git a/docs/assets-and-relationships/bulk-upload-assets.md b/docs/assets-and-relationships/bulk-upload-assets.md
index 5584b0e..f6a89b9 100644
--- a/docs/assets-and-relationships/bulk-upload-assets.md
+++ b/docs/assets-and-relationships/bulk-upload-assets.md
@@ -10,6 +10,7 @@ metadata:
- bulk upload assets
- asset upload failed
- import assets
+ - upload inventory
- confirm and normalize
robots: index
---
@@ -28,8 +29,6 @@ video-status: planned
release-status: draft
-->
-# Bulk upload Assets
-
**Outcome:** Create multiple Assets from a validated CSV or XLSX file, retain a result report, and find the new records.
**For:** Customer administrators and engineers
@@ -59,20 +58,29 @@ The file is checked twice: first for recognizable columns, then row by row. **Co
## Field and option guide
-| UI label or state | Purpose | Required state or accepted format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **Asset Type** | Selects the template and row schema. | Required; **All**, **Custom**, and **Global** are picker filters, not saved values. | Existing Asset Types. | Router | Type column and Asset details. |
-| **Download template** | Gets the current columns for the selected type. | Use the copy downloaded for this run. | WanAware uploader. | `.xlsx` template | Uploaded file and validation. |
-| **Status** column | Chooses Discovery or Inventory when included by the template. | Use only values allowed by the downloaded template. | Your review process. | Discovery | Assets workspace tab. |
-| Asset name column | Supplies the searchable Asset identity. | One non-empty value per row; avoid duplicates. | Approved source data. | edge-router-01 | Asset tables and details. |
-| **Recognized** | Column matched the selected template. | All intended columns should be recognized. | File check. | Asset Name | Row validation. |
-| **Missing** | A required template column is absent. | Must be resolved before upload. | File check. | Required Asset Name column absent | Blocks validation. |
-| **Unknown** | A header is not part of the selected template. | Rename or remove it; do not map by guesswork. | File check. | `Device title` | Blocks or excludes data. |
-| **Valid** | Row can proceed. | No blocking issue. | Row validation. | — | Eligible for normalization. |
-| **Needs Review** | Row has a suggested correction or a value needing confirmation. | Review and accept or correct it. | Row validation. | Normalized spelling suggestion | Must be resolved before final creation. |
-| **Invalid** | Row violates a field or dependency rule. | Correct the named field. | Row validation. | Missing required model | Not created until valid. |
-| **Failed** | Row could not be processed. | Record the error; correct and retry only that row. | Processing result. | Unreadable value | Report and retry file. |
-| **Corrected** | A reviewed row now passes. | Recheck the changed values. | Your correction. | Fixed status | Eligible for normalization. |
+### Information you need
+
+| UI label | What to enter or choose | Where the value comes from |
+| --- | --- | --- |
+| **Asset Type** | Required. Select the type that defines the template and row schema. **All**, **Custom**, and **Global** only filter the picker. | Existing Asset Types. |
+| **Download template** | Download a new copy after selecting the Asset Type. Use that copy for this upload. | WanAware bulk uploader. |
+| **Status** column | Use a value allowed by the template to place each row in Discovery or Inventory. | Your team's review process. |
+| Asset name column | Enter one non-empty, durable identity per row and check for duplicates before uploading. | Approved source data. |
+
+### File and row results
+
+| Result | What it means | What to do next |
+| --- | --- | --- |
+| **Recognized** | The column matches the selected template. | Confirm every intended column appears here. |
+| **Missing** | A required template column is absent. | Add the named column before continuing. |
+| **Unknown** | A header does not belong to the selected template. | Rename or remove it; do not map it by guesswork. |
+| **Valid** | The row has no blocking issue. | Continue to normalization after reviewing the values. |
+| **Needs Review** | WanAware suggests a correction or needs confirmation. | Accept the suggestion or enter the correct value. |
+| **Invalid** | A field or dependency rule failed. | Correct the field named in the row result. |
+| **Failed** | The row could not be processed. | Save the error and retry only the failed row after correction. |
+| **Corrected** | A reviewed row now passes. | Recheck the changed values before normalization. |
+
+After creation, the selected Asset Type appears in the Asset's Type column and details. The Status value determines whether the Asset appears in **Discovery** or **Inventory**.
## Prepare and check the file
@@ -135,16 +143,15 @@ If the browser closes or the outcome is uncertain, search for several unique nam
- For a failed row, preserve its error and row number for Support.
- To stop before **Confirm & Normalize**, close the uploader; no normalized Assets should be created. After confirmation, treat created records as real shared data and use [Delete Assets safely](https://docs.wanaware.com/docs/delete-assets-safely) only after checking dependencies.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Add or import Assets](https://docs.wanaware.com/docs/add-or-import-assets)
-- **Show me:** The add-or-import clip requires a successful release-equivalent test before publication.
-- **Do it:** Open `/assets/inventory` and select **+ Add Asset → Add Bulk Asset**. Contextual help may also open from `/assets/inventory/bulk/upload` or `/assets/discovery/bulk/upload`.
+- **In WanAware:** Open `/assets/inventory` and select **+ Add Asset → Add Bulk Asset**. Contextual help may also open from `/assets/inventory/bulk/upload` or `/assets/discovery/bulk/upload`.
## Next steps
- [Review Discovery and move Assets to Inventory](https://docs.wanaware.com/docs/review-discovery-and-move-assets-to-inventory)
-- [Bulk-import validation failures](https://docs.wanaware.com/docs/bulk-import-validation-failures)
+- [An Asset upload has validation errors](https://docs.wanaware.com/docs/bulk-import-validation-failures)
## Get help
diff --git a/docs/assets-and-relationships/delete-assets-safely.md b/docs/assets-and-relationships/delete-assets-safely.md
index f6ea83f..2890342 100644
--- a/docs/assets-and-relationships/delete-assets-safely.md
+++ b/docs/assets-and-relationships/delete-assets-safely.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Delete Assets safely
-
**Outcome:** Remove only confirmed obsolete Assets after recording their dependencies and verify that no unintended record was affected.
**For:** Customer administrators
@@ -52,12 +50,19 @@ release-status: draft
## Field and option guide
-| UI label | Purpose | Required state or format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| Selection checkbox | Marks an Asset for a bulk action. | Verify each selected row by ID. | Inventory or Discovery table. | One obsolete Asset | Selected count. |
-| **Actions** | Opens row-level actions. | Use only after identity and dependencies are checked. | Asset row. | — | Row action menu. |
-| **Delete** | Removes the selected record or records. | Requires `delete assets` and confirmation. | Row or selection action. | — | Record disappears after completion. |
-| Confirmation count | Shows deletion scope. | Must match the reviewed selection. | Delete dialog. | 1 Asset | Final confirmation. |
+### Before opening Delete
+
+| UI label | What to verify | Where to verify it |
+| --- | --- | --- |
+| Selection checkbox | Every selected row has the intended Asset name and ID. | Inventory or Discovery table. |
+| **Actions** | You have checked Relationships, Structure Tags, Collection membership, and source ownership. | Asset row and Asset details. |
+
+### Confirmation
+
+| UI label | Required check | Expected result |
+| --- | --- | --- |
+| **Delete** | Your Role has `delete assets`, and the Asset is safe to remove. | The confirmation dialog opens; nothing is deleted yet. |
+| Confirmation count | The count exactly matches the reviewed selection. | After confirmation and processing, the record no longer appears in the original result set. |
## Delete the Asset
@@ -86,15 +91,14 @@ If the confirmation scope is wrong, cancel without making changes and clear the
There is no documented self-service restore for this release. If deletion was accidental, stop making related changes and contact Support immediately with the deleted Asset ID, source, page URL, and timestamp. If the source Integration recreates the record, compare its new identity and attachments before treating it as the same Asset.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Find, filter, and inspect Assets](https://docs.wanaware.com/docs/find-filter-and-inspect-assets)
-- **Show me:** No deletion video is planned because the action is consequential.
-- **Do it:** Open `/assets/inventory` or `/assets/discovery` and select only the reviewed record.
+- **In WanAware:** Open `/assets/inventory` or `/assets/discovery` and select only the reviewed record.
## Next steps
-- [Missing, stale, or duplicate Assets](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
+- [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
- [Contact WanAware Support](https://docs.wanaware.com/docs/contact-wanaware-support)
## Get help
diff --git a/docs/assets-and-relationships/find-filter-and-inspect-assets.md b/docs/assets-and-relationships/find-filter-and-inspect-assets.md
index b6f725f..db02214 100644
--- a/docs/assets-and-relationships/find-filter-and-inspect-assets.md
+++ b/docs/assets-and-relationships/find-filter-and-inspect-assets.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Find, filter, and inspect Assets
-
**Outcome:** Locate the intended Asset, prove its identity, and choose the view that answers your question.
**For:** Customers who inspect Assets
@@ -52,16 +50,23 @@ release-status: draft
## Field and option guide
-| UI label | Purpose | Required state or accepted input | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **Discovery** | Shows found or review-stage records. | Select when the Asset has not entered the maintained set. | Asset status. | Found router | Discovery results. |
-| **Inventory** | Shows maintained Assets. | Select for normal asset work. | Asset status. | Production router | Inventory results. |
-| Search | Narrows the current view. | Use a visible name or identifier; search scope can differ by view. | Asset identity. | edge-router-01 | Current result set. |
-| Filters | Narrows by supported properties. | Clear old filters before diagnosing a missing result. | Current Asset data. | Asset Type = Router | Current result set. |
-| **Table** | Compares identity, tags, source, and row actions. | Best first view for exact record selection. | Current tab and filters. | — | Rows and actions. |
-| **Map** | Shows Assets with usable location information. | An Asset without supported location data may not appear. | Saved location fields. | — | Geographic view. |
-| **Graph** | Shows supported connections or groupings for the current scope. | Absence from the graph does not prove the Asset is absent from Inventory. | Relationship and view data. | — | Visual graph. |
-| **Actions** | Opens released row-level actions. | Actions depend on Role and record state. | Asset row. | Delete for an authorized administrator | Action menu. |
+### Find the correct record set
+
+| Control | Use it when | Important limit |
+| --- | --- | --- |
+| **Discovery** | The record was found or imported but still needs review. | A Discovery record does not appear in Inventory until it is moved. |
+| **Inventory** | You need a maintained Asset for normal work. | Inventory does not include records that remain in Discovery. |
+| Search | You know a visible name or identifier, such as `edge-router-01`. | Search scope can differ between Table, Map, and Graph. |
+| Filters | You want a supported property such as Asset Type = Router. | Clear old filters before reporting a missing Asset. |
+
+### Choose a view
+
+| View | Best for | Important limit |
+| --- | --- | --- |
+| **Table** | Comparing identity, tags, source, and row actions. | Use the full Asset ID before acting on similar names. |
+| **Map** | Finding Assets with saved location information. | An Asset without usable location data may not appear. |
+| **Graph** | Exploring supported connections or groupings in the current scope. | Absence from Graph does not prove the Asset is absent from Inventory. |
+| **Actions** | Opening released row-level actions. | Available actions depend on Role and record state. |
## Find the correct record in Table
@@ -76,7 +81,7 @@ release-status: draft
**Expected result:** One record matches both the visible identity and its stable source or Asset ID.
-If no record matches, repeat the same search in the other Asset tab. Do not create a replacement until [Missing, stale, or duplicate Assets](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets) rules out a delayed or filtered record.
+If no record matches, repeat the same search in the other Asset tab. Do not create a replacement until [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets) rules out a delayed or filtered record.
## Use Map
@@ -108,11 +113,10 @@ Refresh the Asset detail page and confirm its ID, Asset Type, source, status, ta
Search and filter changes do not alter Assets. To recover from a confusing view, return to Table, clear search and filters, and reopen the correct tab. If a row action was used accidentally, follow the recovery guidance for that action immediately.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** The Table search clip is pending workflow verification and approval.
-- **Do it:** Open `/assets/inventory`.
+- **In WanAware:** Open `/assets/inventory`.
## Next steps
diff --git a/docs/assets-and-relationships/index.md b/docs/assets-and-relationships/index.md
index 62367ea..03a6302 100644
--- a/docs/assets-and-relationships/index.md
+++ b/docs/assets-and-relationships/index.md
@@ -14,12 +14,33 @@ metadata:
robots: index
---
-# Assets and Relationships
-
An Asset represents a resource that your company tracks, such as a device, service, application, or other supported record. Inventory contains maintained Assets. Discovery holds found records that still need review.
-Add one Asset manually when you know its identity and Asset Type. Use bulk upload for many records of the same Asset Type. Use an Integration when an external system remains the source.
+## Learn
+
+- [Add or import Assets](https://docs.wanaware.com/docs/add-or-import-assets): choose manual creation, bulk upload, or an Integration.
+- [Relationship Discovery Engine](https://docs.wanaware.com/docs/relationship-discovery-engine): understand how supported source data produces Relationships.
+
+## Add and review
+
+- [Add an Asset](https://docs.wanaware.com/docs/add-an-asset)
+- [Bulk upload Assets](https://docs.wanaware.com/docs/bulk-upload-assets)
+- [Review Discovery and move Assets to Inventory](https://docs.wanaware.com/docs/review-discovery-and-move-assets-to-inventory)
+
+## Manage
+
+- [Find, filter, and inspect Assets](https://docs.wanaware.com/docs/find-filter-and-inspect-assets)
+- [Populate Asset details](https://docs.wanaware.com/docs/populate-asset-details)
+- [Manage Data Tags and Structure Tags](https://docs.wanaware.com/docs/manage-asset-and-structure-tags)
+- [Delete Assets safely](https://docs.wanaware.com/docs/delete-assets-safely)
+
+## Relationships
+
+- [View Asset Relationships](https://docs.wanaware.com/docs/view-asset-relationships)
+- [Add a supported network connection](https://docs.wanaware.com/docs/add-a-network-connection)
-After an Asset reaches Inventory, complete the sections defined by its Asset Type. Use **Relationship Graph** to investigate its supported connections.
+## Fix a problem
-WanAware discovers some Relationships from supported source data. **Add Connection** creates specific supported network Relationships. It is not a general drawing tool.
+- [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
+- [An Asset upload has validation errors](https://docs.wanaware.com/docs/bulk-import-validation-failures)
+- [Missing or unexpected Relationships](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
diff --git a/docs/assets-and-relationships/manage-asset-and-structure-tags.md b/docs/assets-and-relationships/manage-asset-and-structure-tags.md
index 5d5a374..96a3ff8 100644
--- a/docs/assets-and-relationships/manage-asset-and-structure-tags.md
+++ b/docs/assets-and-relationships/manage-asset-and-structure-tags.md
@@ -10,6 +10,7 @@ metadata:
- Data Tags
- Structure Tags
- tag asset
+ - attach asset to structure
robots: index
---
@@ -27,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage Data Tags and Structure Tags on an Asset
-
**Outcome:** Apply the correct kind of tag and verify the Asset appears in the intended context.
**For:** Customer administrators and engineers
@@ -80,11 +79,15 @@ Refresh the Asset, then use the Inventory filter for the selected tag. Confirm t
Remove the tag you added or reapply the tag you removed. Save and verify the Asset again. To remove a Structure, follow the Structure deletion guidance instead.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** Use the written steps until a tag-specific clip is approved.
-- **Do it:** Open an Asset from **Functions → Assets → Inventory** (`/assets/inventory`).
+- **In WanAware:** Open an Asset from **Functions → Assets → Inventory** (`/assets/inventory`).
+
+## Next steps
+
+- [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
+- [Find, filter, and inspect Assets](https://docs.wanaware.com/docs/find-filter-and-inspect-assets)
## Get help
diff --git a/docs/assets-and-relationships/populate-asset-details.md b/docs/assets-and-relationships/populate-asset-details.md
index c9186b8..a7b6488 100644
--- a/docs/assets-and-relationships/populate-asset-details.md
+++ b/docs/assets-and-relationships/populate-asset-details.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Populate Asset details
-
**Outcome:** Complete an Asset's editable information and verify that every intended change was saved.
**For:** Customer administrators and engineers responsible for asset data
@@ -92,7 +90,7 @@ If a Structure Tag is unavailable, confirm that the Structure exists and your ro
**Expected result:** The unsaved-change bar clears and the saved values remain visible.
-If the page rejects a field, correct the value before navigating away. If an expected catalog choice is missing, see [Service Catalog failures](https://docs.wanaware.com/docs/service-catalog-failures).
+If the page rejects a field, correct the value before navigating away. If an expected catalog choice is missing, see [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures).
## Check your result
@@ -105,11 +103,10 @@ If the page rejects a field, correct the value before navigating away. If an exp
Restore the previous editable value and save again. Remove only the tag you added. If the source integration overwrites the field, correct the source or ask Support which value is authoritative before repeating the edit.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Asset Types and Service Catalogs](https://docs.wanaware.com/docs/understand-asset-types-and-service-catalogs)
-- **Show me:** The Asset detail clip is pending workflow verification and approval.
-- **Do it:** Open **Functions → Assets → Inventory** (`/assets/inventory`), select an Asset, and use its editable detail tabs.
+- **In WanAware:** Open **Functions → Assets → Inventory** (`/assets/inventory`), select an Asset, and use its editable detail tabs.
## Next steps
diff --git a/docs/assets-and-relationships/relationship-discovery-engine.md b/docs/assets-and-relationships/relationship-discovery-engine.md
index a6cab79..556541f 100644
--- a/docs/assets-and-relationships/relationship-discovery-engine.md
+++ b/docs/assets-and-relationships/relationship-discovery-engine.md
@@ -28,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Relationship Discovery Engine
-
The Relationship Discovery Engine (RDE) builds supported connections after WanAware receives and normalizes asset data. Its results appear in relationship views across the asset experience.
## What RDE uses
@@ -57,7 +55,7 @@ Search, filters, grouping, focus, and depth change what you can see. They do not
- [View asset relationships](https://docs.wanaware.com/docs/view-asset-relationships)
- [Add a supported network connection](https://docs.wanaware.com/docs/add-a-network-connection)
-- [Missing or unexpected relationships](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
+- [A Relationship is missing or unexpected](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
## Get help
diff --git a/docs/assets-and-relationships/review-discovery-and-move-assets-to-inventory.md b/docs/assets-and-relationships/review-discovery-and-move-assets-to-inventory.md
index ddbb165..04dddb0 100644
--- a/docs/assets-and-relationships/review-discovery-and-move-assets-to-inventory.md
+++ b/docs/assets-and-relationships/review-discovery-and-move-assets-to-inventory.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Review Discovery and move Assets to Inventory
-
**Outcome:** Confirm found records belong in the maintained set and move only the intended Assets to Inventory.
**For:** Customer administrators and engineers
@@ -53,12 +51,19 @@ release-status: draft
## Field and option guide
-| UI label | Purpose | Required state or format | Where the value comes from | Example | Where it appears later |
-| --- | --- | --- | --- | --- | --- |
-| **Discovery** | Holds found or review-stage Assets. | Record has Discovery status. | Integration, upload, or manual creation. | Found router | Discovery tab. |
-| Search | Narrows visible records. | Use a name, stable identifier, or other visible identity value. | Source record. | edge-router-01 | Current view only. |
-| Row selection | Chooses records for the action. | Select only records you have reviewed. | Discovery table. | One checked row | Action bar count. |
-| **Move To Inventory** | Promotes selected records. | Requires selection and `update assets`. | Discovery action bar. | — | Inventory after processing. |
+### Select records safely
+
+| Control | What to check | Example |
+| --- | --- | --- |
+| **Discovery** | Confirm you are reviewing found or imported records, not maintained Inventory. | Found router |
+| Search | Use a name, stable identifier, or another visible identity value. | `edge-router-01` |
+| Row selection | Compare the full identity of every selected record and check for an existing Inventory match. | One reviewed row |
+
+### What happens next
+
+| Action | Requirement | Expected result |
+| --- | --- | --- |
+| **Move To Inventory** | At least one reviewed row and `update assets`. | The action enters background processing, then the Asset appears in Inventory and leaves Discovery. |
## Review and move records
@@ -90,16 +95,15 @@ If only some rows move, record the remaining IDs and refresh before retrying. A
Do not delete the Asset to reverse an accidental promotion. First confirm whether your released workspace provides an approved status-edit path for that record. If it does not, contact Support with the Asset ID and promotion timestamp so the record can be assessed without losing Relationships or attachments.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** The Discovery review clip is pending workflow verification and approval.
-- **Do it:** Open `/assets/discovery`.
+- **In WanAware:** Open `/assets/discovery`.
## Next steps
- [Populate Asset details](https://docs.wanaware.com/docs/populate-asset-details)
-- [Missing, stale, or duplicate Assets](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
+- [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
## Get help
diff --git a/docs/assets-and-relationships/view-asset-relationships.md b/docs/assets-and-relationships/view-asset-relationships.md
index d4bb99a..f33c083 100644
--- a/docs/assets-and-relationships/view-asset-relationships.md
+++ b/docs/assets-and-relationships/view-asset-relationships.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# View Asset Relationships
-
**Outcome:** Identify how one Asset is connected to another resource and open the connected record.
**For:** Customer administrators, engineers, and support staff
@@ -94,13 +92,17 @@ Open the connected asset and confirm its name, Asset Type, and source context ma
- Wait for active ingestion and relationship processing to finish.
- Clear graph filters and reduce grouping.
- Compare the graph with source properties.
-- Use [Missing or unexpected relationships](https://docs.wanaware.com/docs/missing-or-unexpected-relationships).
+- Use [A Relationship is missing or unexpected](https://docs.wanaware.com/docs/missing-or-unexpected-relationships).
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Relationship Discovery Engine](https://docs.wanaware.com/docs/relationship-discovery-engine)
-- **Show me:** The captioned relationship clip is pending workflow verification and approval.
-- **Do it:** Open an asset in `/assets/inventory` and select **Relationship Graph**.
+- **In WanAware:** Open an asset in `/assets/inventory` and select **Relationship Graph**.
+
+## Next steps
+
+- [Add a supported network connection](https://docs.wanaware.com/docs/add-a-network-connection)
+- [Fix a missing or unexpected Relationship](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
## Get help
diff --git a/docs/integrations/about-integrations.md b/docs/integrations/about-integrations.md
index c5b5721..0bdaa66 100644
--- a/docs/integrations/about-integrations.md
+++ b/docs/integrations/about-integrations.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# About integrations
-
An integration is a managed connection between WanAware and a supported data source. It is responsible for authentication or authorization, collection, and the source context attached to imported assets.
The core process is the same for each provider:
@@ -49,7 +47,12 @@ Provider adapters explain fields, source-side resources, permissions, and cleanu
- Understand which source-side resources remain if the WanAware integration is removed.
- Never send authorization values to Support.
-Continue with [Add an integration](https://docs.wanaware.com/docs/add-an-integration).
+## Related tasks
+
+- [Add an integration](https://docs.wanaware.com/docs/add-an-integration)
+- [Refresh integration data](https://docs.wanaware.com/docs/refresh-integration-data)
+- [Verify imported Inventory](https://docs.wanaware.com/docs/verify-imported-inventory)
+- [Fix an Integration that does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures)
## Get help
diff --git a/docs/integrations/add-an-integration.md b/docs/integrations/add-an-integration.md
index c8f6b8d..c2b024b 100644
--- a/docs/integrations/add-an-integration.md
+++ b/docs/integrations/add-an-integration.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Add an integration
-
**Outcome:** Connect and test a supported data source, then begin its first inventory collection.
**For:** Customer administrators and source-system owners
@@ -72,7 +70,7 @@ Only enter an authorization value in a field that the current setup explicitly i
5. Enter a clear, unique connection name.
-6. Complete the fields described by the provider adapter.
+6. Enter each value marked required in the provider adapter. Copy account, tenant, region, role, or authorization identifiers from the source-system page named in that guide; do not infer them from a display name.
7. Review the Permissions and source-side resources listed in the setup summary.
8. Select the adapter's documented save or connect button once.
@@ -91,7 +89,7 @@ If a required field is unclear, stop and check the provider adapter. Do not gues
**Expected result:** WanAware accepts the collection request. Inventory collection can continue after you leave the page.
-If the test or request fails, use [Integration connection failures](https://docs.wanaware.com/docs/integration-connection-failures).
+If the test or request fails, use [An Integration does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures).
## Check your result
@@ -106,11 +104,10 @@ Consider the integration verified after a known record appears with the expected
Do not remove a connection by guessing at a control. Removal behavior, imported-Asset impact, and source-side cleanup are provider-specific. Follow the adapter's verified removal procedure or contact Support before changing the connection.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [About integrations](https://docs.wanaware.com/docs/about-integrations)
-- **Show me:** The captioned Integration clip is pending workflow verification and approval.
-- **Do it:** Open **Administration → Integrations** (`/administration/integrations`).
+- **In WanAware:** Open **Administration → Integrations** (`/administration/integrations`).
## Next steps
diff --git a/docs/integrations/index.md b/docs/integrations/index.md
index 076f5f3..0fc2b71 100644
--- a/docs/integrations/index.md
+++ b/docs/integrations/index.md
@@ -13,6 +13,23 @@ metadata:
robots: index
---
-# Integrations
+Integrations bring data from supported providers into WanAware. The general workflow stays the same across providers; credentials and provider-specific options belong in the matching adapter guide.
-Integrations bring data from supported providers into WanAware. Start with [About integrations](https://docs.wanaware.com/docs/about-integrations), then use the provider-neutral [Add an integration](https://docs.wanaware.com/docs/add-an-integration) workflow. Provider-specific requirements live in separate adapter pages so the core setup path remains stable as WanAware adds capabilities.
+## Learn
+
+- [About integrations](https://docs.wanaware.com/docs/about-integrations): understand connections, collection, Discovery, and Inventory.
+- [Provider adapters](https://docs.wanaware.com/docs/providers): find requirements for a specific provider.
+
+## Set up
+
+- [Add an integration](https://docs.wanaware.com/docs/add-an-integration): choose a provider, enter its configuration, test the connection, and start collection.
+
+## Manage
+
+- [Refresh integration data](https://docs.wanaware.com/docs/refresh-integration-data): run collection again and understand its status.
+- [Verify imported Inventory](https://docs.wanaware.com/docs/verify-imported-inventory): confirm the expected Assets reached WanAware.
+
+## Fix a problem
+
+- [An Integration does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures)
+- [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
diff --git a/docs/integrations/providers/aws.md b/docs/integrations/providers/aws.md
index 850cd6c..a3bd4d1 100644
--- a/docs/integrations/providers/aws.md
+++ b/docs/integrations/providers/aws.md
@@ -29,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Amazon Web Services integration adapter
-
**Outcome:** Authorize WanAware to collect supported AWS account inventory through the released role-based setup.
**For:** WanAware customer administrators and AWS account administrators
@@ -103,11 +101,15 @@ Removing the WanAware connection does not automatically delete the CloudFormatio
2. Select **Delete integration…**, read **Delete this AWS integration? This removes the saved account connection.**, and confirm only after approval.
3. Ask the AWS account owner to review and delete the stack if it is no longer required.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [About integrations](https://docs.wanaware.com/docs/about-integrations)
-- **Show me:** Use the general integration clip for the shared WanAware steps after publication.
-- **Do it:** Open `/administration/integrations` in your WanAware workspace.
+- **In WanAware:** Open `/administration/integrations` in your WanAware workspace.
+
+## Next steps
+
+- [Verify imported Inventory](https://docs.wanaware.com/docs/verify-imported-inventory)
+- [Fix an Integration that does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures)
## Get help
diff --git a/docs/integrations/providers/index.md b/docs/integrations/providers/index.md
index 0f99818..69ff053 100644
--- a/docs/integrations/providers/index.md
+++ b/docs/integrations/providers/index.md
@@ -12,6 +12,4 @@ metadata:
robots: index
---
-# Provider adapters
-
Use the adapter that matches the provider shown in **Administration → Integrations**. Each adapter covers provider-specific fields, permissions, source-side resources, verification, and cleanup. Return to [Add an integration](https://docs.wanaware.com/docs/add-an-integration) for the shared workflow.
diff --git a/docs/integrations/refresh-integration-data.md b/docs/integrations/refresh-integration-data.md
index 0310879..40fec50 100644
--- a/docs/integrations/refresh-integration-data.md
+++ b/docs/integrations/refresh-integration-data.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Refresh integration data
-
**Outcome:** Start the provider adapter's documented collection action and confirm that WanAware accepted the request.
**For:** Customer administrators and source-system owners
@@ -81,11 +79,15 @@ WanAware does not provide one action that reverses a completed collection. Corre
Contact Support before deleting multiple records.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [About integrations](https://docs.wanaware.com/docs/about-integrations)
-- **Show me:** The integration clip shows the refresh checkpoint after publication.
-- **Do it:** Open **Administration → Integrations** (`/administration/integrations`).
+- **In WanAware:** Open **Administration → Integrations** (`/administration/integrations`).
+
+## Next steps
+
+- [Verify imported Inventory](https://docs.wanaware.com/docs/verify-imported-inventory)
+- [Fix an Integration that does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures)
## Get help
diff --git a/docs/integrations/verify-imported-inventory.md b/docs/integrations/verify-imported-inventory.md
index 16e1b34..ea65a4b 100644
--- a/docs/integrations/verify-imported-inventory.md
+++ b/docs/integrations/verify-imported-inventory.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Verify imported Inventory
-
**Outcome:** Find a known source record and confirm that WanAware imported it into the correct workspace.
**For:** Customer administrators and engineers
@@ -79,11 +77,15 @@ If a record is missing, also check **Discovery** and wait for active processing
Compare the source and WanAware side by side. Record the source identifier, WanAware asset ID, and collection time for each verified example.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [About integrations](https://docs.wanaware.com/docs/about-integrations)
-- **Show me:** The Integration verification clip is pending workflow verification and approval.
-- **Do it:** Open **Functions → Assets → Inventory** (`/assets/inventory`).
+- **In WanAware:** Open **Functions → Assets → Inventory** (`/assets/inventory`).
+
+## Next steps
+
+- [Review Discovery and move Assets to Inventory](https://docs.wanaware.com/docs/review-discovery-and-move-assets-to-inventory)
+- [Find, filter, and inspect Assets](https://docs.wanaware.com/docs/find-filter-and-inspect-assets)
## Get help
diff --git a/docs/start-here/administrator-setup-path.md b/docs/start-here/administrator-setup-path.md
index 255aecf..7297ddc 100644
--- a/docs/start-here/administrator-setup-path.md
+++ b/docs/start-here/administrator-setup-path.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Administrator setup path
-
**Outcome:** Prepare a workspace that another user can explore without needing you to explain the model.
**For:** Customer administrators and implementation leads
@@ -64,11 +62,10 @@ Use a Role with `read assets` to complete [Your first 30 minutes](https://docs.w
Remove documentation-only records in reverse order: detach Structure Tags, remove test Collections and Elements, remove test assets, and only then remove their draft configuration. Never delete a published Asset Type or shared integration without reviewing its current use.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** Use the five short clips linked from each core workflow after they are published.
-- **Do it:** Open `/administration/integrations` in your WanAware workspace.
+- **In WanAware:** Open `/administration/integrations` in your WanAware workspace.
## Get help
diff --git a/docs/start-here/choose-your-path.md b/docs/start-here/choose-your-path.md
index 9415a14..d6782b0 100644
--- a/docs/start-here/choose-your-path.md
+++ b/docs/start-here/choose-your-path.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Choose your path
-
Choose one path now. You can return for the other later.
## Explore WanAware
diff --git a/docs/start-here/index.md b/docs/start-here/index.md
index 605009a..6483df5 100644
--- a/docs/start-here/index.md
+++ b/docs/start-here/index.md
@@ -13,11 +13,24 @@ metadata:
robots: index
---
-# Start here
+Choose the shortest path to a useful result. You do not need to learn the entire product first.
-You do not need to learn every part of WanAware before you can get value from it.
+## Explore
-- **Explore WanAware** if your environment already has data. Find an Asset, review its details, and understand one useful Relationship in about 30 minutes.
-- **Build your environment** if you are setting up the workspace. Add a data source, define your Asset model, and organize Assets for your team.
+- [Your first 30 minutes](https://docs.wanaware.com/docs/your-first-30-minutes): find an Asset and follow one Relationship.
+- [Use Launchpad](https://docs.wanaware.com/docs/use-launchpad): understand the cards and routes available to your Role.
-[Choose your path](https://docs.wanaware.com/docs/choose-your-path) explains where to begin. If you are evaluating a shared workspace, read [Use a shared evaluation workspace safely](https://docs.wanaware.com/docs/use-the-demo-safely) before making changes.
+## Set up
+
+- [Administrator setup path](https://docs.wanaware.com/docs/administrator-setup-path): add data, define the Asset model, and organize the workspace.
+- [Use a shared evaluation workspace safely](https://docs.wanaware.com/docs/use-the-demo-safely): understand changes, cleanup, and actions that require approval.
+
+## Learn
+
+- [Choose your path](https://docs.wanaware.com/docs/choose-your-path): compare the Explore and Build paths.
+- [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology): find product areas, paths, permissions, and definitions.
+
+## Fix a problem
+
+- [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions)
+- [Troubleshooting and support](https://docs.wanaware.com/docs/troubleshooting-and-support)
diff --git a/docs/start-here/product-map-and-terminology.md b/docs/start-here/product-map-and-terminology.md
index 6bfb633..b0c63e5 100644
--- a/docs/start-here/product-map-and-terminology.md
+++ b/docs/start-here/product-map-and-terminology.md
@@ -30,8 +30,6 @@ video-status: not-planned
release-status: draft
-->
-# Product map and terminology
-
The left navigation shows only the areas included in your company's subscription and allowed by your active Role. Opening a direct URL does not bypass those checks.
Throughout this knowledge base, capitalized words such as **Asset**, **Asset Type**, **Structure**, **Element**, **Discovery**, and **Inventory** are WanAware product labels or record types. Lowercase words are generic. Permission names remain lowercase because they match their IAM identifiers.
@@ -58,7 +56,7 @@ Permissions are written as `action resource`. When a row lists more than one per
| **Theme Settings** | Choose your personal Light or Dark appearance and an available preset. | Top-bar drawer; no page URL | Available to a signed-in user; there is no separate feature permission. |
| **Support** | Open the in-product Support area. | `/support` | `view support` |
-The navigation requirement controls entry to an area. Create, update, delete, publish, attach, and other actions can require additional permissions. If a page or action is missing, use [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
+The navigation requirement controls entry to an area. Create, update, delete, publish, attach, and other actions can require additional permissions. If a page or action is missing, use [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
## How the records fit together
@@ -187,13 +185,12 @@ A named set of Permissions assigned to members. A Role controls which pages and
An allowed action on a resource, such as `read assets`. Permissions are collected into Roles rather than assigned as navigation labels.
- **Where:** **Administration → IAM → Roles → [Role]** (`/administration/iam/roles/{roleKey}`)
-- **See also:** [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions)
+- **See also:** [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions)
-## Learn, show me, do it
+## Learn and continue
- **Learn:** Use this page as the glossary and navigation map for the first release.
-- **Show me:** Use the short clips linked from the matching task guides after publication.
-- **Do it:** Start with [Choose your path](https://docs.wanaware.com/docs/choose-your-path).
+- **In WanAware:** Start with [Choose your path](https://docs.wanaware.com/docs/choose-your-path).
## Get help
diff --git a/docs/start-here/use-launchpad.md b/docs/start-here/use-launchpad.md
index edc3314..13207fc 100644
--- a/docs/start-here/use-launchpad.md
+++ b/docs/start-here/use-launchpad.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Use Launchpad
-
Launchpad is the starting view for your workspace. Its cards summarize available information and provide a route into detailed records. The exact cards and counts depend on your role, company configuration, and current data.
Use a card to identify what deserves attention, then open the related product area to confirm the underlying records. Do not treat a card count as an editable source of truth.
diff --git a/docs/start-here/use-the-demo-safely.md b/docs/start-here/use-the-demo-safely.md
index e96a58d..f09da0b 100644
--- a/docs/start-here/use-the-demo-safely.md
+++ b/docs/start-here/use-the-demo-safely.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Use a shared evaluation workspace safely
-
**Outcome:** Explore the product and create approved test records without disrupting a shared workspace.
**For:** Anyone using a shared trial, sandbox, or evaluation workspace
@@ -95,11 +93,15 @@ Never enter production credentials, passwords, tokens, private keys, real custom
Continue after you can identify the read-only actions and the actions that require approval. Record how to remove every temporary record you create.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** The first-30-minutes safety clip is pending workflow verification and approval.
-- **Do it:** Open `/launchpad` and follow [Your first 30 minutes](https://docs.wanaware.com/docs/your-first-30-minutes).
+- **In WanAware:** Open `/launchpad` and follow [Your first 30 minutes](https://docs.wanaware.com/docs/your-first-30-minutes).
+
+## Next steps
+
+- [Your first 30 minutes](https://docs.wanaware.com/docs/your-first-30-minutes)
+- [Administrator setup path](https://docs.wanaware.com/docs/administrator-setup-path)
## Get help
diff --git a/docs/start-here/welcome-to-wanaware.md b/docs/start-here/welcome-to-wanaware.md
index f499dbc..6cc5dae 100644
--- a/docs/start-here/welcome-to-wanaware.md
+++ b/docs/start-here/welcome-to-wanaware.md
@@ -27,24 +27,63 @@ video-status: not-planned
release-status: draft
-->
-# Welcome to WanAware
+WanAware brings your Assets, their business context, and their Relationships into one place. Choose the path that matches what you need to accomplish now.
-WanAware gives your team one place to see the assets in an environment, complete the information people need, and understand how those assets are related.
+
+
+ **Outcome:** Find a known Asset, understand its details, and follow one useful Relationship.
-The quickest way to see that value is to open a known asset and follow one connection in its **Relationship Graph**. If you are responsible for setup, start with the administrator path and build the model in a deliberate order.
+ - **For:** Anyone exploring an existing workspace
+ - **Permission:** `read my_launchpad` and `read assets`
+ - **Time:** 10–30 minutes
+
+
+ **Outcome:** Add data, define how Assets are described, and organize them for your team.
-## Choose a starting point
+ - **For:** Customer administrators
+ - **Permission:** Administrative permissions vary by task
+ - **Time:** Start with a 15-minute setup sequence
+
+
-- [Explore WanAware](https://docs.wanaware.com/docs/your-first-30-minutes): find an asset, review its details, and understand one relationship.
-- [Build your environment](https://docs.wanaware.com/docs/administrator-setup-path): configure integrations, Asset Types, Service Catalogs, Structures, Elements, and Collections.
-- [Use a shared evaluation workspace safely](https://docs.wanaware.com/docs/use-the-demo-safely): understand what you can change and how to recover from an unintended action.
-- [Find a page or term](https://docs.wanaware.com/docs/product-map-and-terminology): use the product map and glossary.
+
+
+The quickest way to understand the workspace is to open a known Asset and follow one connection in its **Relationship Graph**. If the workspace has no data yet, start with the administrator path.
+
+## Common tasks
+
+
+
+ Choose between a manual Asset, bulk upload, or an Integration.
+
+
+ Update editable fields, tags, and catalog-backed choices, then verify the saved result.
+
+
+ Create a supported network connection or investigate a Relationship that already exists.
+
+
+ Start from AI, a template, or scratch, then configure the draft before publishing it.
+
+
+ Understand Structures, Elements, Collections, and the attachment paths between them.
+
+
+ Invite a user, assign a Role, and confirm the invitation status.
+
+
+
+Before changing shared data, read [Use a shared evaluation workspace safely](https://docs.wanaware.com/docs/use-the-demo-safely). For definitions and navigation paths, use [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology).
## Access varies by role
WanAware uses Role-based access. People in the same company may see different pages and actions.
-If an instruction names a missing action, ask a customer administrator to check your Role. Use [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions) before treating the issue as a product failure.
+If an instruction names a missing action, ask a customer administrator to check your Role. Use [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions) before treating the issue as a product failure.
+
+## Something is not working
+
+Start with [Troubleshooting and support](https://docs.wanaware.com/docs/troubleshooting-and-support). Choose the article that matches the visible symptom or exact error before changing configuration or deleting data.
## Get help
diff --git a/docs/start-here/your-first-30-minutes.md b/docs/start-here/your-first-30-minutes.md
index 6457c34..b3d1350 100644
--- a/docs/start-here/your-first-30-minutes.md
+++ b/docs/start-here/your-first-30-minutes.md
@@ -37,8 +37,6 @@ video-status: planned
release-status: draft
-->
-# Your first 30 minutes
-
**Outcome:** Find one asset, confirm what it is, and identify at least one connected resource.
**For:** Customer administrators, engineers, and support staff
@@ -78,7 +76,7 @@ release-status: draft
**Expected result:** The inventory opens. Counts and Launchpad cards can vary by role and company configuration.
-If a page is missing, see [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
+If a page is missing, see [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
## 2. Find a known asset
@@ -121,11 +119,10 @@ You have completed the Explore path when you can answer:
- Which resource is connected to it?
- Why is that connection useful to your work?
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Product map and terminology](https://docs.wanaware.com/docs/product-map-and-terminology)
-- **Show me:** The captioned first-30-minutes clip is pending workflow verification and approval.
-- **Do it:** Open `/launchpad` in your WanAware workspace.
+- **In WanAware:** Open `/launchpad` in your WanAware workspace.
## Next steps
diff --git a/docs/structures-elements-and-collections/attach-collections-to-structures.md b/docs/structures-elements-and-collections/attach-collections-to-structures.md
index 4ecb460..ae3b798 100644
--- a/docs/structures-elements-and-collections/attach-collections-to-structures.md
+++ b/docs/structures-elements-and-collections/attach-collections-to-structures.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Attach Collections to Structures
-
**Outcome:** Attach a Collection to the intended Structure node with a Structure Tag.
**For:** Customer administrators and engineers
@@ -78,11 +76,15 @@ Refresh the Collection and confirm the Structure Tag. Open **Structures**, expan
Remove the tag you added or reapply the one you removed, then save and verify. Detaching a Collection should not delete the Collection, its Element, or its assets.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** The Collection attachment clip is pending workflow verification and approval.
-- **Do it:** Open **Functions → Elements** (`/elements`), select an Element, and expand the Collection.
+- **In WanAware:** Open **Functions → Elements** (`/elements`), select an Element, and expand the Collection.
+
+## Next steps
+
+- [Create Collections and add Assets](https://docs.wanaware.com/docs/create-collections-and-add-assets)
+- [Fix an Element or Collection attachment](https://docs.wanaware.com/docs/structure-element-or-collection-attachment-failures)
## Get help
diff --git a/docs/structures-elements-and-collections/attach-elements-to-structures.md b/docs/structures-elements-and-collections/attach-elements-to-structures.md
index daa1413..5b6db53 100644
--- a/docs/structures-elements-and-collections/attach-elements-to-structures.md
+++ b/docs/structures-elements-and-collections/attach-elements-to-structures.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Attach Elements to Structures
-
**Outcome:** Attach an Element to the intended Structure node with a Structure Tag.
**For:** Customer administrators and engineers
@@ -80,11 +78,15 @@ To detach the Element, clear the Structure Tag and save. To restore the attachme
Detaching an Element does not delete the Element or the Structure.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** The Element attachment clip is pending workflow verification and approval.
-- **Do it:** Open **Functions → Elements** (`/elements`) and select the intended Element.
+- **In WanAware:** Open **Functions → Elements** (`/elements`) and select the intended Element.
+
+## Next steps
+
+- [Create and populate Elements](https://docs.wanaware.com/docs/create-and-populate-elements)
+- [Fix an Element or Collection attachment](https://docs.wanaware.com/docs/structure-element-or-collection-attachment-failures)
## Get help
diff --git a/docs/structures-elements-and-collections/create-and-manage-structures.md b/docs/structures-elements-and-collections/create-and-manage-structures.md
index d9e8ad8..f26ebf1 100644
--- a/docs/structures-elements-and-collections/create-and-manage-structures.md
+++ b/docs/structures-elements-and-collections/create-and-manage-structures.md
@@ -29,8 +29,6 @@ video-status: planned
release-status: draft
-->
-# Create and manage Structures
-
**Outcome:** Create a Structure node of the correct type and place it in the intended hierarchy.
**For:** Customer administrators and environment model owners
@@ -96,11 +94,10 @@ Search for the exact name, expand its parent, and confirm the type, location, an
Restore the previous editable value when possible. Before removing a Structure, detach its Elements and Collections and review its child nodes. Do not delete the attached assets themselves.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** The Structure hierarchy clip is pending workflow verification and approval.
-- **Do it:** Open `/structures` in your WanAware workspace.
+- **In WanAware:** Open `/structures` in your WanAware workspace.
## Next steps
diff --git a/docs/structures-elements-and-collections/create-and-populate-elements.md b/docs/structures-elements-and-collections/create-and-populate-elements.md
index d3885a6..d17f13c 100644
--- a/docs/structures-elements-and-collections/create-and-populate-elements.md
+++ b/docs/structures-elements-and-collections/create-and-populate-elements.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Create and populate Elements
-
**Outcome:** Create an Application, Service, or Site Element and complete the details supported by that type.
**For:** Customer administrators and engineers
@@ -81,7 +79,7 @@ release-status: draft
## Populate its details
1. Select **View Element**.
-2. Edit the name if needed.
+2. Compare **Element Name** with the approved name. Change it only when the saved value is incorrect or no longer uniquely identifies the Element.
3. Add approved Data Tags and **Structure Tags**.
4. Open **Collections** to review or add asset groups.
5. For a Site, open **Site Assets** and **Location**.
@@ -101,11 +99,10 @@ Search for the Element by exact name, open it, and confirm its type, tags, Colle
Remove an incorrect tag or asset attachment from the Element. Before deleting the Element, review its Collections, Site Assets, Location, and Structure Tags. Do not delete attached assets to remove the Element.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** The Element creation clip is pending workflow verification and approval.
-- **Do it:** Open **Functions → Elements** (`/elements`).
+- **In WanAware:** Open **Functions → Elements** (`/elements`).
## Next steps
diff --git a/docs/structures-elements-and-collections/create-collections-and-add-assets.md b/docs/structures-elements-and-collections/create-collections-and-add-assets.md
index 53ab4ba..4799b0d 100644
--- a/docs/structures-elements-and-collections/create-collections-and-add-assets.md
+++ b/docs/structures-elements-and-collections/create-collections-and-add-assets.md
@@ -27,8 +27,6 @@ video-status: planned
release-status: draft
-->
-# Create Collections and add Assets
-
**Outcome:** Create a named Collection inside an Element and add the intended assets once.
**For:** Customer administrators and engineers
@@ -92,11 +90,10 @@ Open the Collection and compare every listed asset ID with the intended set. Con
Remove an incorrect Asset from the Collection. Before deleting the Collection, review its Assets and Structure Tags. Do not delete the Assets themselves.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** The Collection workflow clip is pending workflow verification and approval.
-- **Do it:** Open `/elements`, choose an Element, and select **Collections**.
+- **In WanAware:** Open `/elements`, choose an Element, and select **Collections**.
## Next steps
diff --git a/docs/structures-elements-and-collections/index.md b/docs/structures-elements-and-collections/index.md
index 242ab4e..24d63cf 100644
--- a/docs/structures-elements-and-collections/index.md
+++ b/docs/structures-elements-and-collections/index.md
@@ -14,8 +14,24 @@ metadata:
robots: index
---
-# Structures, Elements, and Collections
-
Use **Structures** for hierarchy, **Elements** for operational units such as Applications, Services, and Sites, and **Collections** to group assets inside an Element. Structure Tags attach Elements and Collections to the hierarchy.
-Start with [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections) before creating shared records.
+## Learn
+
+- [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections): choose the correct record and attachment path.
+
+## Set up
+
+1. [Create and manage Structures](https://docs.wanaware.com/docs/create-and-manage-structures).
+2. [Create and populate Elements](https://docs.wanaware.com/docs/create-and-populate-elements).
+3. [Attach Elements to Structures](https://docs.wanaware.com/docs/attach-elements-to-structures).
+4. [Create Collections and add Assets](https://docs.wanaware.com/docs/create-collections-and-add-assets).
+5. [Attach Collections to Structures](https://docs.wanaware.com/docs/attach-collections-to-structures).
+
+## Manage
+
+- [Manage Site details](https://docs.wanaware.com/docs/manage-site-details)
+
+## Fix a problem
+
+- [An Element or Collection does not attach to a Structure](https://docs.wanaware.com/docs/structure-element-or-collection-attachment-failures)
diff --git a/docs/structures-elements-and-collections/manage-site-details.md b/docs/structures-elements-and-collections/manage-site-details.md
index c62efe1..46d2106 100644
--- a/docs/structures-elements-and-collections/manage-site-details.md
+++ b/docs/structures-elements-and-collections/manage-site-details.md
@@ -27,8 +27,6 @@ video-status: not-planned
release-status: draft
-->
-# Manage Site details
-
**Outcome:** Complete the Site-specific information on a Site Element and verify its asset and location context.
**For:** Customer administrators and engineers
@@ -85,11 +83,15 @@ Refresh the Site, confirm its tags, open **Site Assets**, and verify each asset.
Detach an incorrect Site Asset rather than deleting the asset. Restore the previous Location value and save. Review Collections and Structure Tags before deleting the Site.
-## Learn, show me, do it
+## Learn and continue
- **Learn:** [Understand Structures, Elements, and Collections](https://docs.wanaware.com/docs/understand-structures-elements-and-collections)
-- **Show me:** Use the written steps until a Site-specific clip is approved.
-- **Do it:** Open `/elements`, select a Site, and use **Site Assets** and **Location**.
+- **In WanAware:** Open `/elements`, select a Site, and use **Site Assets** and **Location**.
+
+## Next steps
+
+- [Create and populate Elements](https://docs.wanaware.com/docs/create-and-populate-elements)
+- [Create Collections and add Assets](https://docs.wanaware.com/docs/create-collections-and-add-assets)
## Get help
diff --git a/docs/structures-elements-and-collections/understand-structures-elements-and-collections.md b/docs/structures-elements-and-collections/understand-structures-elements-and-collections.md
index bcbf693..3532229 100644
--- a/docs/structures-elements-and-collections/understand-structures-elements-and-collections.md
+++ b/docs/structures-elements-and-collections/understand-structures-elements-and-collections.md
@@ -28,8 +28,6 @@ video-status: planned
release-status: draft
-->
-# Understand Structures, Elements, and Collections
-
WanAware uses three related records for organization:
@@ -51,6 +49,14 @@ A **Structure Tag** connects an Element or Collection to one node in a Structure
Start with the smallest model that answers a real question. Avoid creating separate records with nearly identical names to represent the same concept.
+## Related tasks
+
+- [Create and manage Structures](https://docs.wanaware.com/docs/create-and-manage-structures)
+- [Create and populate Elements](https://docs.wanaware.com/docs/create-and-populate-elements)
+- [Attach Elements to Structures](https://docs.wanaware.com/docs/attach-elements-to-structures)
+- [Create Collections and add Assets](https://docs.wanaware.com/docs/create-collections-and-add-assets)
+- [Attach Collections to Structures](https://docs.wanaware.com/docs/attach-collections-to-structures)
+
## Get help
Email [support@wanaware.com](mailto:support@wanaware.com?subject=WanAware%20organization%20model%20question) with your company, affected user, record names or IDs, page URL, timestamp and time zone, and the hierarchy you are trying to represent. Never send passwords, credentials, tokens, or secret values.
diff --git a/docs/troubleshooting-and-support/asset-type-save-or-publish-failures.md b/docs/troubleshooting-and-support/asset-type-save-or-publish-failures.md
index fb36518..24bd9ea 100644
--- a/docs/troubleshooting-and-support/asset-type-save-or-publish-failures.md
+++ b/docs/troubleshooting-and-support/asset-type-save-or-publish-failures.md
@@ -1,15 +1,16 @@
---
-title: Asset Type save or publish failures
+title: An Asset Type does not save or publish
excerpt: Resolve draft validation, dependency, permission, and publication problems.
deprecated: false
hidden: false
metadata:
- title: Asset Type save or publish failures | WanAware Documentation
+ title: An Asset Type does not save or publish | WanAware Documentation
description: Fix errors when saving or publishing a custom WanAware Asset Type.
keywords:
- Asset Type save failed
- publish Asset Type failed
- field validation
+ - cannot save Asset Type
robots: index
---
@@ -27,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Asset Type save or publish failures
-
Use this page when **Save Draft**, **Save Changes**, or **Publish** is unavailable or returns an error.
WanAware displays **Save Draft** while creating a draft and **Save Changes** while editing one. Use the exact label shown for the current Asset Type state.
diff --git a/docs/troubleshooting-and-support/billing-and-payment-failures.md b/docs/troubleshooting-and-support/billing-and-payment-failures.md
index 0ae1446..5e8d259 100644
--- a/docs/troubleshooting-and-support/billing-and-payment-failures.md
+++ b/docs/troubleshooting-and-support/billing-and-payment-failures.md
@@ -1,16 +1,17 @@
---
-title: Billing and payment failures
+title: A billing or payment action fails
excerpt: Diagnose missing billing access, unsuccessful payment actions, invoice problems, and unclear subscription state.
deprecated: false
hidden: false
metadata:
- title: Billing and payment failures | WanAware Documentation
+ title: A billing or payment action fails | WanAware Documentation
description: Troubleshoot WanAware plan, usage, payment, invoice, and subscription issues safely.
keywords:
- billing failed
- payment failed
- invoice missing
- plan change failed
+ - cannot download invoice
robots: index
---
@@ -28,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Billing and payment failures
-
Use this page when Billing is missing, a payment or plan action fails, an invoice is unavailable, or the displayed subscription state is unclear.
## Fast checks
diff --git a/docs/troubleshooting-and-support/bulk-import-validation-failures.md b/docs/troubleshooting-and-support/bulk-import-validation-failures.md
index 3fba898..8f9bbd5 100644
--- a/docs/troubleshooting-and-support/bulk-import-validation-failures.md
+++ b/docs/troubleshooting-and-support/bulk-import-validation-failures.md
@@ -1,10 +1,10 @@
---
-title: Bulk-import validation failures
+title: An Asset upload has validation errors
excerpt: Correct file, schema, field, and duplicate errors before importing assets.
deprecated: false
hidden: false
metadata:
- title: Bulk-import validation failures | WanAware Documentation
+ title: An Asset upload has validation errors | WanAware Documentation
description: Fix WanAware asset bulk-upload file and row validation errors.
keywords:
- bulk upload error
@@ -12,6 +12,7 @@ metadata:
- CSV validation
- rejected rows
- schema error
+ - upload inventory failed
robots: index
---
@@ -29,8 +30,6 @@ video-status: not-planned
release-status: draft
-->
-# Bulk-import validation failures
-
Use the uploader's current template. Templates and required fields can change as asset types change.
## Fast checks
diff --git a/docs/troubleshooting-and-support/contact-wanaware-support.md b/docs/troubleshooting-and-support/contact-wanaware-support.md
index c218db6..4e45c3a 100644
--- a/docs/troubleshooting-and-support/contact-wanaware-support.md
+++ b/docs/troubleshooting-and-support/contact-wanaware-support.md
@@ -29,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Contact WanAware Support
-
Email [support@wanaware.com](mailto:support@wanaware.com?subject=WanAware%20support%20request) when the published checks do not solve the problem.
Send one issue per email so the subject, evidence, and resolution stay together.
diff --git a/docs/troubleshooting-and-support/index.md b/docs/troubleshooting-and-support/index.md
index 1382d14..7cbf9da 100644
--- a/docs/troubleshooting-and-support/index.md
+++ b/docs/troubleshooting-and-support/index.md
@@ -14,10 +14,27 @@ metadata:
robots: index
---
-# Troubleshooting and support
+Choose the symptom closest to what you see. Start with the fast checks before changing configuration or deleting shared data.
-Choose the article that matches the visible symptom or exact error. Each article starts with low-risk checks that rule out filters, access, and processing delays.
+## Sign-in and access
-Complete those checks before changing configuration or deleting data. This order protects shared records while narrowing the likely cause.
+- [I cannot sign in, reset my password, or complete MFA](https://docs.wanaware.com/docs/sign-in-password-and-mfa)
+- [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions)
-If the published steps do not solve the problem, [contact WanAware Support](https://docs.wanaware.com/docs/contact-wanaware-support). Include the requested evidence, but never send a password, access token, secret, or private key.
+## Data and integrations
+
+- [An Integration does not connect or collect](https://docs.wanaware.com/docs/integration-connection-failures)
+- [An Asset is missing, stale, or duplicated](https://docs.wanaware.com/docs/missing-stale-or-duplicate-assets)
+- [An Asset upload has validation errors](https://docs.wanaware.com/docs/bulk-import-validation-failures)
+- [A Relationship is missing or unexpected](https://docs.wanaware.com/docs/missing-or-unexpected-relationships)
+
+## Configuration
+
+- [An Asset Type does not save or publish](https://docs.wanaware.com/docs/asset-type-save-or-publish-failures)
+- [A Service Catalog entry does not save](https://docs.wanaware.com/docs/service-catalog-failures)
+- [An Element or Collection does not attach to a Structure](https://docs.wanaware.com/docs/structure-element-or-collection-attachment-failures)
+- [A billing or payment action fails](https://docs.wanaware.com/docs/billing-and-payment-failures)
+
+## Contact Support
+
+If the checks do not solve the problem, [contact WanAware Support](https://docs.wanaware.com/docs/contact-wanaware-support). Include the requested evidence, but never send a password, access token, secret, or private key.
diff --git a/docs/troubleshooting-and-support/integration-connection-failures.md b/docs/troubleshooting-and-support/integration-connection-failures.md
index 938533f..e3d9a3d 100644
--- a/docs/troubleshooting-and-support/integration-connection-failures.md
+++ b/docs/troubleshooting-and-support/integration-connection-failures.md
@@ -1,10 +1,10 @@
---
-title: Integration connection failures
+title: An Integration does not connect or collect
excerpt: Diagnose setup, authorization, connection-test, and data-collection failures for supported integrations.
deprecated: false
hidden: false
metadata:
- title: Integration connection failures | WanAware Documentation
+ title: An Integration does not connect or collect | WanAware Documentation
description: Fix WanAware integration setup, authorization, connection-test, and collection errors.
keywords:
- integration failed
@@ -12,6 +12,7 @@ metadata:
- data collection failed
- sync failed
- inventory collection failed
+ - integration not connecting
robots: index
---
@@ -29,8 +30,6 @@ video-status: not-planned
release-status: draft
-->
-# Integration connection failures
-
Use these checks when WanAware cannot start provider setup, save an integration, verify access, or collect data.
## Fast checks
diff --git a/docs/troubleshooting-and-support/missing-or-unexpected-relationships.md b/docs/troubleshooting-and-support/missing-or-unexpected-relationships.md
index 713337b..d8064d1 100644
--- a/docs/troubleshooting-and-support/missing-or-unexpected-relationships.md
+++ b/docs/troubleshooting-and-support/missing-or-unexpected-relationships.md
@@ -1,10 +1,10 @@
---
-title: Missing or unexpected relationships
+title: A Relationship is missing or unexpected
excerpt: Check processing, source identity, graph filters, and relationship inputs before reporting a graph problem.
deprecated: false
hidden: false
metadata:
- title: Missing or unexpected relationships | WanAware Documentation
+ title: A Relationship is missing or unexpected | WanAware Documentation
description: Troubleshoot empty, missing, duplicated, or incorrect WanAware asset relationships.
keywords:
- relationship missing
@@ -12,6 +12,8 @@ metadata:
- wrong relationship
- graph data
- RDE
+ - connect assets
+ - add relationship
robots: index
---
@@ -29,8 +31,6 @@ video-status: not-planned
release-status: draft
-->
-# Missing or unexpected relationships
-
A relationship can appear after both assets are present and the applicable relationship processing has finished.
## Fast checks
diff --git a/docs/troubleshooting-and-support/missing-pages-actions-or-permissions.md b/docs/troubleshooting-and-support/missing-pages-actions-or-permissions.md
index 5e7845f..2d4fdcb 100644
--- a/docs/troubleshooting-and-support/missing-pages-actions-or-permissions.md
+++ b/docs/troubleshooting-and-support/missing-pages-actions-or-permissions.md
@@ -1,10 +1,10 @@
---
-title: Missing pages, actions, or permissions
+title: A page or action is missing
excerpt: Determine whether a missing feature is caused by role access, company context, subscription, or product availability.
deprecated: false
hidden: false
metadata:
- title: Missing pages, actions, or permissions | WanAware Documentation
+ title: A page or action is missing | WanAware Documentation
description: Troubleshoot missing WanAware navigation, buttons, actions, and permission errors.
keywords:
- missing page
@@ -13,6 +13,8 @@ metadata:
- 403
- role access
- feature not visible
+ - cannot see page
+ - cannot see action
robots: index
---
@@ -30,8 +32,6 @@ video-status: not-planned
release-status: draft
-->
-# Missing pages, actions, or permissions
-
WanAware hides navigation and actions that are not available to the current Role. A missing button is often an access or subscription question, not a loading failure.
## Fast checks
diff --git a/docs/troubleshooting-and-support/missing-stale-or-duplicate-assets.md b/docs/troubleshooting-and-support/missing-stale-or-duplicate-assets.md
index fcf0cab..6aa4854 100644
--- a/docs/troubleshooting-and-support/missing-stale-or-duplicate-assets.md
+++ b/docs/troubleshooting-and-support/missing-stale-or-duplicate-assets.md
@@ -1,10 +1,10 @@
---
-title: Missing, stale, or duplicate Assets
+title: An Asset is missing, stale, or duplicated
excerpt: Determine whether filters, workspace context, crawl timing, status, or source identity explains an asset problem.
deprecated: false
hidden: false
metadata:
- title: Missing, stale, or duplicate assets | WanAware Documentation
+ title: An Asset is missing, stale, or duplicated | WanAware Documentation
description: Troubleshoot missing, outdated, or duplicated WanAware asset records.
keywords:
- missing asset
@@ -12,6 +12,7 @@ metadata:
- duplicate asset
- inventory not updated
- discovery
+ - cannot find asset
robots: index
---
@@ -29,8 +30,6 @@ video-status: not-planned
release-status: draft
-->
-# Missing, stale, or duplicate Assets
-
Do not delete or recreate an Asset until you have checked its source identity and processing state.
## Fast checks
diff --git a/docs/troubleshooting-and-support/service-catalog-failures.md b/docs/troubleshooting-and-support/service-catalog-failures.md
index 8458615..64cde68 100644
--- a/docs/troubleshooting-and-support/service-catalog-failures.md
+++ b/docs/troubleshooting-and-support/service-catalog-failures.md
@@ -1,15 +1,16 @@
---
-title: Service Catalog failures
+title: A Service Catalog entry does not save
excerpt: Resolve missing Asset Types, unavailable entry actions, invalid compatibility, and save failures.
deprecated: false
hidden: false
metadata:
- title: Service Catalog failures | WanAware Documentation
+ title: A Service Catalog entry does not save | WanAware Documentation
description: Fix missing entries, compatibility, and save problems in WanAware Service Catalog.
keywords:
- Service Catalog failed
- catalog entry missing
- compatibility missing
+ - cannot save catalog entry
robots: index
---
@@ -27,8 +28,6 @@ video-status: not-planned
release-status: draft
-->
-# Service Catalog failures
-
Use this page when a draft Asset Type, catalog action, entry, compatible choice, or saved value is missing.
## Fast checks
@@ -46,7 +45,7 @@ Use this page when a draft Asset Type, catalog action, entry, compatible choice,
| --- | --- | --- |
| Draft Asset Type is absent | The save failed, the wrong company is selected, or access is missing | Reopen **Asset Types**, confirm **Draft** status, then check the Permission. |
| Model action is absent | A compatible parent has not been selected | Select the required provider or manufacturer context first. |
-| Module or Software is absent | The selected context does not support that child type | Select the appropriate manufacturer and use only the available entry types. |
+| Module or Software is absent | The selected context does not support that child type | Open the saved **Manufacturer**, then check whether that parent exposes **Module** or **Software**. If it does not, do not create a substitute entry type. |
| Save fails | A required name, source, specification, or attribute is invalid | Correct the labeled field and save again. |
| Expected compatible choice is missing | The catalog entry lacks the compatibility selection, or its parent value differs | Reopen the Service Catalog entry, correct compatibility, save, and refresh the Asset. |
| Entry appears twice | A near-duplicate was added | Preserve both records, identify current usage, and remove only the unused custom entry after review. |
diff --git a/docs/troubleshooting-and-support/sign-in-password-and-mfa.md b/docs/troubleshooting-and-support/sign-in-password-and-mfa.md
index a624c1c..bb06812 100644
--- a/docs/troubleshooting-and-support/sign-in-password-and-mfa.md
+++ b/docs/troubleshooting-and-support/sign-in-password-and-mfa.md
@@ -1,10 +1,10 @@
---
-title: Sign-in, password, and MFA problems
+title: I cannot sign in, reset my password, or complete MFA
excerpt: Recover access when sign-in, password reset, invitation, or multi-factor authentication does not work.
deprecated: false
hidden: false
metadata:
- title: Sign-in, password, and MFA problems | WanAware Documentation
+ title: I cannot sign in, reset my password, or complete MFA | WanAware Documentation
description: Troubleshoot WanAware sign-in, password reset, invitations, Google sign-in, and MFA.
keywords:
- cannot sign in
@@ -12,6 +12,7 @@ metadata:
- reset password
- MFA problem
- invitation expired
+ - login failed
robots: index
---
@@ -29,8 +30,6 @@ video-status: not-planned
release-status: draft
-->
-# Sign-in, password, and MFA problems
-
Use this page when sign-in fails, a reset email does not arrive, an invitation does not work, or MFA blocks access.
## Fast checks
@@ -56,7 +55,7 @@ Use this page when sign-in fails, a reset email does not arrive, an invitation d
## Verify the fix
-Sign in, confirm the company workspace, and open one page required for your role. If only the page is missing, use [Missing pages, actions, or permissions](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
+Sign in, confirm the company workspace, and open one page required for your role. If only the page is missing, use [A page or action is missing](https://docs.wanaware.com/docs/missing-pages-actions-or-permissions).
## Known limitations
diff --git a/docs/troubleshooting-and-support/structure-element-or-collection-attachment-failures.md b/docs/troubleshooting-and-support/structure-element-or-collection-attachment-failures.md
index 51f3b94..1579eaa 100644
--- a/docs/troubleshooting-and-support/structure-element-or-collection-attachment-failures.md
+++ b/docs/troubleshooting-and-support/structure-element-or-collection-attachment-failures.md
@@ -1,16 +1,17 @@
---
-title: Structure, Element, or Collection attachment failures
+title: An Element or Collection does not attach to a Structure
excerpt: Fix missing Structure Tags, unavailable assets, failed saves, and unexpected attachments.
deprecated: false
hidden: false
metadata:
- title: Organization attachment failures | WanAware Documentation
+ title: An Element or Collection does not attach to a Structure | WanAware Documentation
description: Troubleshoot WanAware Structure Tag, Element, Collection, and asset attachments.
keywords:
- attach Element to Structure failed
- attach Collection to Structure failed
- Structure Tag missing
- asset missing from Collection
+ - attach asset to structure
robots: index
---
@@ -28,8 +29,6 @@ video-status: not-planned
release-status: draft
-->
-# Structure, Element, or Collection attachment failures
-
Use this page when a Structure Tag or Asset cannot be selected, saved, removed, or found in the expected organizational view.
## Fast checks
diff --git a/integration/portal-help-links.json b/integration/portal-help-links.json
index 0d9ea97..475e1e8 100644
--- a/integration/portal-help-links.json
+++ b/integration/portal-help-links.json
@@ -27,7 +27,6 @@
{ "portalRoute": "/administration/asset-types/edit/:assetTypeId", "article": "/docs/configure-asset-type-sections-and-fields", "label": "Configure an Asset Type" },
{ "portalRoute": "/administration/service-catalog", "article": "/docs/create-a-custom-service-catalog", "label": "Configure Service Catalog" },
{ "portalRoute": "/administration/service-catalog/:assetTypeId", "article": "/docs/add-catalog-entries-and-compatibility", "label": "Manage catalog entries" },
- { "portalRoute": "/administration/service-catalog/:assetTypeId/bulk-upload", "article": "/docs/bulk-upload-service-catalog-entries", "label": "Bulk upload Service Catalog entries" },
{ "portalRoute": "/administration/iam", "article": "/docs/invite-users-and-assign-roles", "label": "Manage users and Roles" },
{ "portalRoute": "/administration/iam/roles", "article": "/docs/create-and-edit-roles", "label": "Create and edit Roles" },
{ "portalRoute": "ui:iam-resend-invitation", "article": "/docs/manage-pending-invitations", "label": "Manage a pending invitation" },
diff --git a/integration/publication-gate.json b/integration/publication-gate.json
index f9e832e..479e483 100644
--- a/integration/publication-gate.json
+++ b/integration/publication-gate.json
@@ -1,6 +1,6 @@
{
"status": "blocked-pending-release-evidence-and-approval",
- "branch": "v1.0_kb-readme-repair",
+ "branch": "v1.0_kb-customer-docs-improvements",
"publishBranch": "v1.0",
"contentScope": "first-release-customer-guides",
"blockingChecks": [
@@ -13,7 +13,7 @@
"status": "pending"
},
{
- "check": "All 47 screenshot slots recaptured or cropped to remove internal URLs, workspace identity, record identifiers, account menus, notifications, and sensitive data; then optimized, reviewed, uploaded to ReadMe, and linked with useful alt text",
+ "check": "All 87 screenshot-capable action states captured or explicitly blocked; visible launch workflows have complete, sanitized, full-width ReadMe-hosted visuals beside the relevant steps",
"status": "blocked-pending-sanitized-recapture"
},
{
@@ -30,7 +30,7 @@
},
{
"check": "Product approval for behavioral accuracy",
- "status": "pending"
+ "status": "passing"
},
{
"check": "Support approval for clarity, diagnostic value, and escalation instructions",
diff --git a/integration/readme-redirects.csv b/integration/readme-redirects.csv
index 8c62edd..f1ccf2b 100644
--- a/integration/readme-redirects.csv
+++ b/integration/readme-redirects.csv
@@ -1,10 +1,10 @@
source_path,target_path,redirect_type,status
-/docs/getting-started,/docs/welcome-to-wanaware,301,pending-launch
-/docs/asset-discovery,/docs/find-filter-and-inspect-assets,301,pending-launch
-/docs/asset-inventory,/docs/find-filter-and-inspect-assets,301,pending-launch
-/docs/relationship-discovery-engine-rde,/docs/relationship-discovery-engine,301,pending-launch
+/docs/getting-started,/docs/welcome-to-wanaware,301,ready-after-approval
+/docs/asset-discovery,/docs/find-filter-and-inspect-assets,301,ready-after-approval
+/docs/asset-inventory,/docs/find-filter-and-inspect-assets,301,ready-after-approval
+/docs/relationship-discovery-engine-rde,/docs/relationship-discovery-engine,301,ready-after-approval
/docs/knowledge-discovery-engine-kde,/docs/welcome-to-wanaware,302,pending-product-decision
-/docs/connect-an-aws-account,/docs/aws,301,pending-launch
-/docs/create-elements-and-collections,/docs/understand-structures-elements-and-collections,301,pending-launch
-/docs/organize-your-environment,/docs/understand-structures-elements-and-collections,301,pending-launch
-/docs/administration-and-access,/docs/administration-and-personal-settings,301,pending-launch
+/docs/connect-an-aws-account,/docs/aws,301,ready-after-approval
+/docs/create-elements-and-collections,/docs/understand-structures-elements-and-collections,301,ready-after-approval
+/docs/organize-your-environment,/docs/understand-structures-elements-and-collections,301,ready-after-approval
+/docs/administration-and-access,/docs/administration-and-personal-settings,301,ready-after-approval
diff --git a/integration/readme-settings.json b/integration/readme-settings.json
index 6142a77..c56c96f 100644
--- a/integration/readme-settings.json
+++ b/integration/readme-settings.json
@@ -4,7 +4,7 @@
"publicBaseUrl": "https://docs.wanaware.com",
"gitRepository": "wanaware/customer-docs",
"liveBranch": "v1.0",
- "reviewBranch": "v1.0_kb-readme-repair",
+ "reviewBranch": "v1.0_kb-customer-docs-improvements",
"visibility": "public",
"topLevelAreas": [
"Guides",
@@ -19,6 +19,15 @@
"Administration and Personal Settings",
"Troubleshooting and Support"
],
+ "guideCategoryTitles": {
+ "start-here": "Start Here",
+ "integrations": "Integrations",
+ "assets-and-relationships": "Assets and Relationships",
+ "asset-types-and-service-catalog": "Asset Types and Service Catalog",
+ "structures-elements-and-collections": "Structures, Elements, and Collections",
+ "administration-and-personal-settings": "Administration and Personal Settings",
+ "troubleshooting-and-support": "Troubleshooting and Support"
+ },
"launchSettings": {
"goalOrientedLandingPage": true,
"search": true,
diff --git a/integration/search-quality-questions.json b/integration/search-quality-questions.json
index 74c7275..aa4790c 100644
--- a/integration/search-quality-questions.json
+++ b/integration/search-quality-questions.json
@@ -1,5 +1,5 @@
{
- "version": 3,
+ "version": 4,
"minimumCorrectPercent": 90,
"requirements": {
"citationsRequired": true,
@@ -7,24 +7,24 @@
"forbiddenSources": ["private repositories", "customer data", "internal engineering documentation"]
},
"questions": [
- { "question": "I just signed in. What should I do first?", "expectedSlug": "/docs/your-first-30-minutes", "mustMention": ["Assets", "Relationship Graph"], "mustNotMention": ["internal architecture"] },
+ { "question": "Where should I start after signing in?", "expectedSlug": "/docs/your-first-30-minutes", "mustMention": ["Assets", "Relationship Graph"], "mustNotMention": ["internal architecture"] },
{ "question": "What can I safely change in a trial or shared evaluation workspace?", "expectedSlug": "/docs/use-the-demo-safely", "mustMention": ["sample records", "recover"], "mustNotMention": ["production credentials"] },
{ "question": "How do I add an integration?", "expectedSlug": "/docs/add-an-integration", "mustMention": ["provider adapter", "connection"], "mustNotMention": ["send credentials to Support"] },
- { "question": "How do I bulk upload Assets?", "expectedSlug": "/docs/bulk-upload-assets", "mustMention": ["Upload & Validate", "Confirm & Normalize"], "mustNotMention": ["resubmit successful rows"] },
- { "question": "Why did my Asset upload fail?", "expectedSlug": "/docs/bulk-import-validation-failures", "mustMention": ["row", "exact error"], "mustNotMention": ["guess"] },
+ { "question": "How do I bulk upload Assets or upload inventory?", "expectedSlug": "/docs/bulk-upload-assets", "mustMention": ["Upload & Validate", "Confirm & Normalize"], "mustNotMention": ["resubmit successful rows"] },
+ { "question": "My Asset upload failed or has validation errors. How do I fix it?", "expectedSlug": "/docs/bulk-import-validation-failures", "mustMention": ["row", "exact error"], "mustNotMention": ["guess"] },
{ "question": "How do I move Discovery records to Inventory?", "expectedSlug": "/docs/review-discovery-and-move-assets-to-inventory", "mustMention": ["Move To Inventory", "duplicate"], "mustNotMention": [] },
{ "question": "How do I edit and save Asset details?", "expectedSlug": "/docs/populate-asset-details", "mustMention": ["unsaved-change", "refresh"], "mustNotMention": [] },
- { "question": "How do I connect Assets or add a Relationship?", "expectedSlug": "/docs/add-a-network-connection", "mustMention": ["eligible", "preview"], "mustNotMention": ["arbitrary relationship"] },
- { "question": "Why is a Relationship missing?", "expectedSlug": "/docs/missing-or-unexpected-relationships", "mustMention": ["filters", "both Assets"], "mustNotMention": [] },
+ { "question": "How do I connect Assets or add a relationship?", "expectedSlug": "/docs/add-a-network-connection", "mustMention": ["eligible", "preview"], "mustNotMention": ["arbitrary relationship"] },
+ { "question": "A relationship is missing or wrong. What should I check?", "expectedSlug": "/docs/missing-or-unexpected-relationships", "mustMention": ["filters", "both Assets"], "mustNotMention": [] },
{ "question": "How do I create a custom Asset Type?", "expectedSlug": "/docs/create-a-custom-asset-type", "mustMention": ["Draft", "starting option"], "mustNotMention": [] },
{ "question": "What happens when I publish an Asset Type?", "expectedSlug": "/docs/publish-and-verify-an-asset-type", "mustMention": ["read-only", "verify"], "mustNotMention": [] },
- { "question": "How do I create a Service Catalog?", "expectedSlug": "/docs/create-a-custom-service-catalog", "mustMention": ["draft Asset Type", "Save"], "mustNotMention": [] },
+ { "question": "How do I create a catalog or Service Catalog?", "expectedSlug": "/docs/create-a-custom-service-catalog", "mustMention": ["draft Asset Type", "Save"], "mustNotMention": [] },
{ "question": "How do I bulk upload Service Catalog entries?", "expectedSlug": "/docs/bulk-upload-service-catalog-entries", "mustMention": ["column mapping", "Create N entries"], "mustNotMention": ["verified in every environment"] },
{ "question": "Where do I find an existing provider ID for a catalog upload?", "expectedSlug": "/docs/prepare-a-service-catalog-bulk-upload-file", "mustMention": ["existing Service Catalog", "stable ID"], "mustNotMention": ["provider name is the ID"] },
{ "question": "How do I fix a Service Catalog import conflict?", "expectedSlug": "/docs/bulk-upload-service-catalog-entries", "mustMention": ["Conflicts", "revalidate"], "mustNotMention": ["ignore the conflict"] },
{ "question": "How do I attach an Element or Collection to a Structure?", "expectedSlug": "/docs/attach-elements-to-structures", "mustMention": ["Structure Tags", "save"], "mustNotMention": [] },
- { "question": "How do I invite a teammate and assign a Role?", "expectedSlug": "/docs/invite-users-and-assign-roles", "mustMention": ["IAM", "Role"], "mustNotMention": [] },
- { "question": "Why can my teammate not see a page or action?", "expectedSlug": "/docs/missing-pages-actions-or-permissions", "mustMention": ["Role", "Permission"], "mustNotMention": [] },
+ { "question": "How do I invite a teammate or assign a Role?", "expectedSlug": "/docs/invite-users-and-assign-roles", "mustMention": ["IAM", "Role"], "mustNotMention": [] },
+ { "question": "Why can I not see a page or action?", "expectedSlug": "/docs/missing-pages-actions-or-permissions", "mustMention": ["Role", "Permission"], "mustNotMention": [] },
{ "question": "Where do I find billing, payment methods, usage, or invoices?", "expectedSlug": "/docs/understand-billing", "mustMention": ["Plans", "Billing History"], "mustNotMention": ["fixed price"] },
{ "question": "The docs did not solve my issue. What should I send Support?", "expectedSlug": "/docs/contact-wanaware-support", "mustMention": ["timestamp", "page URL", "exact error"], "mustNotMention": ["password value", "access token value"] }
]
diff --git a/media/publishing-manifest.json b/media/publishing-manifest.json
index 370f26a..9783acb 100644
--- a/media/publishing-manifest.json
+++ b/media/publishing-manifest.json
@@ -147,18 +147,18 @@
{
"id": "assets-create",
"kind": "screenshot",
- "source": "media/screenshots/source/add-asset-form.png",
- "publishingFile": "media/screenshots/add-asset-form.png",
- "sha256": "25b95a3474defa6ba78057ad42d4ce937837644142bbd126e0c131e6807c27ac",
- "width": 1786,
- "height": 1136,
- "bytes": 113689,
- "alt": "Add Asset form showing status, tags, schema tabs, and catalog-backed fields for the selected Asset Type.",
+ "source": "media/screenshots/source/add-asset-input-state.png",
+ "publishingFile": "media/screenshots/add-asset-input-state.png",
+ "sha256": "d8b4a66801013f6748c10498793f8041e5ae3c6a78c03d91dcf883884520f387",
+ "width": 1800,
+ "height": 1132,
+ "bytes": 99261,
+ "alt": "Add Asset form showing a sample name, Inventory status, and required IP Block fields before submission.",
"articles": [
"/docs/add-an-asset"
],
- "publishedUrl": "https://files.readme.io/3ee1b6636411448bac08983d9d9ad903511f635dff718beb436b6ba18f7632f4-add-asset-form.png",
- "renderedOn": "2026-09-03",
+ "publishedUrl": "https://files.readme.io/07a0242867fc88b01afff516ad5e33ee3a0f95c1f9f75e1459a25ea0691f05cd-add-asset-input-state.png",
+ "renderedOn": "2026-09-04",
"approvalState": "pending-product-support-review"
},
{
@@ -340,6 +340,7 @@
"articles": [
"/docs/missing-or-unexpected-relationships",
"/docs/view-asset-relationships",
+ "/docs/welcome-to-wanaware",
"/docs/your-first-30-minutes"
],
"publishedUrl": "https://files.readme.io/e7db6b94b13b42103b48e405a82aa443fbbba2af036bdbfc2996c4d8b8170c41-asset-relationship-graph.png",
@@ -725,6 +726,314 @@
"publishedUrl": "https://files.readme.io/9c68b865170382016a815e68e7a191201ba5726de477a561a4ff2bdab99a2f48-site-location.png",
"renderedOn": "2026-09-03",
"approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "assets-create-success",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/add-asset-success.png",
+ "publishingFile": "media/screenshots/add-asset-success.png",
+ "sha256": "5e9a2abafb86eac266824fa6cbafc4680e12f1b3a158116444b1ea058bc0bfe7",
+ "width": 1800,
+ "height": 972,
+ "bytes": 52729,
+ "alt": "Asset Added confirmation showing the saved status and the View Asset, Add Another, and Done next actions.",
+ "articles": [
+ "/docs/add-an-asset"
+ ],
+ "publishedUrl": "https://files.readme.io/2a73c1f7d75aa61f97ba7502ec7564b2d42ee9b528728c0b4b860093de90c6c2-add-asset-success.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "asset-types-actions",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/asset-type-actions-menu.png",
+ "publishingFile": "media/screenshots/asset-type-actions-menu.png",
+ "sha256": "f5a70a0da8dfcd47f24451fe4b8e391138df692d9477db3d3de40070f2e3b73d",
+ "width": 1800,
+ "height": 672,
+ "bytes": 148894,
+ "alt": "Asset Type actions menu showing view, open, clone, visibility, copy, and delete actions for a published example row.",
+ "articles": [
+ "/docs/create-a-custom-asset-type"
+ ],
+ "publishedUrl": "https://files.readme.io/a59349bb53972422d7a34c194c1347083629dddfbf31c4548438f1740378e059-asset-type-actions-menu.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "personal-theme",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/theme-settings-light-and-dark.png",
+ "publishingFile": "media/screenshots/theme-settings-light-and-dark.png",
+ "sha256": "66ccd72e7435c7c0712c0d913f353a7811e62f83010b6c2cfebca0193eb28504",
+ "width": 1800,
+ "height": 1022,
+ "bytes": 146462,
+ "alt": "Theme Settings showing the available Light and Dark modes and color presets.",
+ "articles": [
+ "/docs/choose-a-theme"
+ ],
+ "publishedUrl": "https://files.readme.io/bababdfbea8a1fbebc998a60a50586adea6315925cc1016f5a2705f1cc642cfe-theme-settings-light-and-dark.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "catalog-workspace",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/service-catalog-workspace.png",
+ "publishingFile": "media/screenshots/service-catalog-workspace.png",
+ "sha256": "c1c626fb4534585cbced4f44ac785afd115f0ae529a9d620369889989f2fa53b",
+ "width": 1800,
+ "height": 692,
+ "bytes": 105063,
+ "alt": "Service Catalog workspace showing an example catalog, provider hierarchy, services, search, refresh, and add actions.",
+ "articles": [
+ "/docs/create-a-custom-service-catalog"
+ ],
+ "publishedUrl": "https://files.readme.io/109fd5e29eabcb97c7f0402dbe6ec95ccc4701290d0f68f1e5d6c58e7e05e169-service-catalog-workspace.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "catalog-entry",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/service-catalog-entry-form.png",
+ "publishingFile": "media/screenshots/service-catalog-entry-form.png",
+ "sha256": "bc992e19ca0dc3ffacb831df72d2d7056e6ad0ddacc3d03f734e68a5e96da815",
+ "width": 1800,
+ "height": 1096,
+ "bytes": 137044,
+ "alt": "Add Provider form showing entry type, source, name, description, linked service type, version, and specifications.",
+ "articles": [
+ "/docs/create-a-custom-service-catalog"
+ ],
+ "publishedUrl": "https://files.readme.io/96bdabdeee105efdffb65447085562aba19e2d4b43a5b9b7157d1f403680ea6c-service-catalog-entry-form.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "catalog-components",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/service-catalog-models-components.png",
+ "publishingFile": "media/screenshots/service-catalog-models-components.png",
+ "sha256": "44c4009502c9da70f17dd8e6f8c44a958f0efaa876c55d50dd131997a764959e",
+ "width": 1800,
+ "height": 692,
+ "bytes": 102865,
+ "alt": "Service Catalog item showing an example service name, description, prefix, routing type, scope, and update action.",
+ "articles": [
+ "/docs/add-catalog-entries-and-compatibility"
+ ],
+ "publishedUrl": "https://files.readme.io/361cc34e9a8827f7539cc31abcea175ff8c1d7a2c9bc6efe82a989ce4b7fe5fe-service-catalog-models-components.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "catalog-bulk-import-choice",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/catalog-bulk-import-choice.png",
+ "publishingFile": "media/screenshots/catalog-bulk-import-choice.png",
+ "sha256": "e8c07c4830ed3bd6d4e77f4de5266df7d3e4a898db0c2e0e9d534fea7e2cc0a3",
+ "width": 1800,
+ "height": 1022,
+ "bytes": 110127,
+ "alt": "Service Catalog bulk uploader showing new-provider and existing-provider choices, file and paste inputs, and validation actions.",
+ "articles": [
+ "/docs/bulk-upload-service-catalog-entries",
+ "/docs/prepare-a-service-catalog-bulk-upload-file"
+ ],
+ "publishedUrl": "https://files.readme.io/db24e54e650041262b05f564439f74233545b657469d92f2b788a487d70c4a04-catalog-bulk-import-choice.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-roles-list",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/iam-roles-list.png",
+ "publishingFile": "media/screenshots/iam-roles-list.png",
+ "sha256": "18ceb6f9be2e36b5ae1c2eb4a52c7341a402495c4f196d192ea9dfc8b887d61d",
+ "width": 1786,
+ "height": 632,
+ "bytes": 41518,
+ "alt": "IAM Roles list showing system and customer Roles, member counts, Permissions, and the Create Role action.",
+ "articles": [
+ "/docs/create-and-edit-roles"
+ ],
+ "publishedUrl": "https://files.readme.io/3431077d146ae19f5296ef7967e8f70f01c4b0ea784da2adb5f81cc739f95869-iam-roles-list.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-roles",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/iam-role-editor.png",
+ "publishingFile": "media/screenshots/iam-role-editor.png",
+ "sha256": "67a7f6ab4b404dd90c374ab3c0b17319efc9e92931b7158f3e19b4b6d5eeee62",
+ "width": 1786,
+ "height": 1136,
+ "bytes": 138255,
+ "alt": "Create Role page showing the Name field and grouped action-resource Permission selections.",
+ "articles": [
+ "/docs/create-and-edit-roles"
+ ],
+ "publishedUrl": "https://files.readme.io/0534e10ef59e6fdbdafd9fc2c149bf61b655dc11eaa9d3bf2132d6bc2ddaaa0a-iam-role-editor.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "asset-types-save-draft",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/asset-type-draft-result.png",
+ "publishingFile": "media/screenshots/asset-type-draft-result.png",
+ "sha256": "a2b5189fef5bc087b64b0205db2443258b458868b840620044678a047e269902",
+ "width": 1786,
+ "height": 452,
+ "bytes": 48795,
+ "alt": "Custom Asset Type list showing the newly saved example schema with Draft status and its available actions.",
+ "articles": [
+ "/docs/configure-asset-type-sections-and-fields",
+ "/docs/create-a-custom-asset-type"
+ ],
+ "publishedUrl": "https://files.readme.io/a946bbbb205a2a7a7c43a2187d9e0b6fea6b71362cff2fd1badbdc70d0205334-asset-type-draft-result.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "asset-types-publish-confirm",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/asset-type-publish-confirmation.png",
+ "publishingFile": "media/screenshots/asset-type-publish-confirmation.png",
+ "sha256": "f2d9ac04a58bca9c65db167f8600afe946d043e7a259e33170099199498bbd04",
+ "width": 1793,
+ "height": 872,
+ "bytes": 60222,
+ "alt": "Asset Type publication confirmation showing the read-only consequence before the destructive action is confirmed.",
+ "articles": [
+ "/docs/publish-and-verify-an-asset-type"
+ ],
+ "publishedUrl": "https://files.readme.io/16b43df026c7b93507620c29fdff3e6a818160ef714343fd402d5aa824138b72-asset-type-publish-confirmation.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "asset-types-delete-confirm",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/asset-type-delete-confirmation.png",
+ "publishingFile": "media/screenshots/asset-type-delete-confirmation.png",
+ "sha256": "01d1aa487c72596633a8f6426a825f10691648a954756b5926e37a6dff568f1a",
+ "width": 1793,
+ "height": 872,
+ "bytes": 51569,
+ "alt": "Delete Asset Type confirmation showing the affected draft name and the permanent deletion warning.",
+ "articles": [
+ "/docs/create-a-custom-asset-type"
+ ],
+ "publishedUrl": "https://files.readme.io/80ad09ada788d5988de28bc39206ae2b75af43f42c925d6a0b2664d09ca3987f-asset-type-delete-confirmation.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-user-create",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/invite-user-form.png",
+ "publishingFile": "media/screenshots/invite-user-form.png",
+ "sha256": "acf7c4a24311ba110513792b55fb80940b442282c6fc0cc6583e31ef3fbe4f48",
+ "width": 1500,
+ "height": 522,
+ "bytes": 41852,
+ "alt": "Create User form showing the User name, Email, Role selection, and Create User action with sample values.",
+ "articles": [
+ "/docs/invite-users-and-assign-roles"
+ ],
+ "publishedUrl": "https://files.readme.io/d36aede7c22d78f94ef1b914ecab0697bee19100c324c60c78a07f387c4f8d17-invite-user-form.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-company-logo",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/company-branding.png",
+ "publishingFile": "media/screenshots/company-branding.png",
+ "sha256": "7d0b9e6ace664d9b6ff4a8122891f2b90c9d998978a3dac10b5fd3ca543da5b6",
+ "width": 1786,
+ "height": 432,
+ "bytes": 24177,
+ "alt": "Platform Customization settings showing Dark Mode Logo and Light Mode Logo upload controls.",
+ "articles": [
+ "/docs/manage-company-settings"
+ ],
+ "publishedUrl": "https://files.readme.io/86716aa8e278f798f5e6bba4691e8f856f7e7ad6431ec1bc1e67dcc5d03621b6-company-branding.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "personal-profile-general",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/profile-preferences.png",
+ "publishingFile": "media/screenshots/profile-preferences.png",
+ "sha256": "cfb7453fb38a2e65eac6a4626ab97d8db6c4c92f188fd404269fe41258016c3f",
+ "width": 1786,
+ "height": 397,
+ "bytes": 28379,
+ "alt": "Personal General settings showing Timezone, time and date formats, and the Profile Avatar upload control.",
+ "articles": [
+ "/docs/manage-profile-and-security"
+ ],
+ "publishedUrl": "https://files.readme.io/f5ddd02942292f774e059689d4404b4b25f3e068bab35590e561fea2f52a0eb2-profile-preferences.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "personal-password",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/profile-security.png",
+ "publishingFile": "media/screenshots/profile-security.png",
+ "sha256": "96037be59ded3576954dda86cd2d8eeb511de1fc58d0d169f8dba5a091d1b8b9",
+ "width": 1786,
+ "height": 872,
+ "bytes": 51009,
+ "alt": "Security settings showing enabled Authenticator App status and blank Current and New Password fields.",
+ "articles": [
+ "/docs/manage-profile-and-security"
+ ],
+ "publishedUrl": "https://files.readme.io/cd9790ffdfe6cc294d24e83a90dda42d817dc61ce5bb94fe828a64ba7f24632e-profile-security.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-role-create-result",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/iam-role-created-result.png",
+ "publishingFile": "media/screenshots/iam-role-created-result.png",
+ "sha256": "28d6ac20c46c6401f6de6adc7dceb46100c5b832b2e5833d1b0f2d13df817672",
+ "width": 1800,
+ "height": 497,
+ "bytes": 54183,
+ "alt": "Saved customer Role showing one selected read Assets Permission on the Permissions tab.",
+ "articles": [
+ "/docs/create-and-edit-roles"
+ ],
+ "publishedUrl": "https://files.readme.io/1b40d0ecb3506785ef2487af33918fc84bf3819e3e83e24de677b90e04ac6cd8-image.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
+ },
+ {
+ "id": "administration-role-delete-confirm",
+ "kind": "screenshot",
+ "source": "media/screenshots/source/iam-role-delete-confirmation.png",
+ "publishingFile": "media/screenshots/iam-role-delete-confirmation.png",
+ "sha256": "e46b0da05123373c3e5e0bc87700e57222bbf0f2cfd89ebf0596a41a7e6342fd",
+ "width": 1800,
+ "height": 452,
+ "bytes": 69777,
+ "alt": "Delete Role confirmation identifying the selected customer Role and warning that deletion cannot be undone.",
+ "articles": [
+ "/docs/create-and-edit-roles"
+ ],
+ "publishedUrl": "https://files.readme.io/606771bd138d3b448d60a4885c49d19e58c77eead82c98aec7a9c38fdb95d5ce-iam-role-delete-confirmation.png",
+ "renderedOn": "2026-09-04",
+ "approvalState": "pending-product-support-review"
}
],
"screenshotPolicy": {
diff --git a/media/screenshot-manifest.json b/media/screenshot-manifest.json
index e5bf817..17566be 100644
--- a/media/screenshot-manifest.json
+++ b/media/screenshot-manifest.json
@@ -97,11 +97,11 @@
},
{
"id": "assets-create",
- "file": "media/screenshots/add-asset-form.png",
- "sourceFile": "media/screenshots/source/add-asset-form.png",
+ "file": "media/screenshots/add-asset-input-state.png",
+ "sourceFile": "media/screenshots/source/add-asset-input-state.png",
"article": "/docs/add-an-asset",
- "alt": "Add Asset form showing status, tags, schema tabs, and catalog-backed fields for the selected Asset Type.",
- "captureDate": "2026-09-03",
+ "alt": "Add Asset form showing a sample name, Inventory status, and required IP Block fields before submission.",
+ "captureDate": "2026-09-04",
"style": "wanaware-ai-assisted-v4",
"status": "captured-pending-product-support-review"
},
@@ -287,26 +287,45 @@
"alt": "Draft Asset Type and publication confirmation explaining the read-only consequence.",
"status": "pending-product-approval"
},
+ {
+ "id": "asset-types-actions",
+ "file": "media/screenshots/asset-type-actions-menu.png",
+ "sourceFile": "media/screenshots/source/asset-type-actions-menu.png",
+ "article": "/docs/create-a-custom-asset-type",
+ "alt": "Asset Type actions menu showing view, open, clone, visibility, copy, and delete actions for a published example row.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
+ },
{
"id": "catalog-workspace",
"file": "media/screenshots/service-catalog-workspace.png",
+ "sourceFile": "media/screenshots/source/service-catalog-workspace.png",
"article": "/docs/create-a-custom-service-catalog",
- "alt": "Service Catalog workspace with a sanitized draft Asset Type selected.",
- "status": "blocked-pending-sanitized-recapture"
+ "alt": "Service Catalog workspace showing an example catalog, provider hierarchy, services, search, refresh, and add actions.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "catalog-entry",
"file": "media/screenshots/service-catalog-entry-form.png",
+ "sourceFile": "media/screenshots/source/service-catalog-entry-form.png",
"article": "/docs/create-a-custom-service-catalog",
- "alt": "Service Catalog entry form with sanitized name, description, and attribute fields.",
- "status": "pending-demo-records"
+ "alt": "Add Provider form showing entry type, source, name, description, linked service type, version, and specifications.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "catalog-components",
"file": "media/screenshots/service-catalog-models-components.png",
+ "sourceFile": "media/screenshots/source/service-catalog-models-components.png",
"article": "/docs/add-catalog-entries-and-compatibility",
- "alt": "Service Catalog item showing a documentation-only service or circuit type and its specifications.",
- "status": "blocked-pending-sanitized-recapture"
+ "alt": "Service Catalog item showing an example service name, description, prefix, routing type, scope, and update action.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "catalog-compatibility",
@@ -318,9 +337,12 @@
{
"id": "catalog-bulk-import-choice",
"file": "media/screenshots/catalog-bulk-import-choice.png",
+ "sourceFile": "media/screenshots/source/catalog-bulk-import-choice.png",
"article": "/docs/prepare-a-service-catalog-bulk-upload-file",
- "alt": "Service Catalog bulk uploader showing new-provider and existing-provider import choices.",
- "status": "pending-release-equivalent-verification"
+ "alt": "Service Catalog bulk uploader showing new-provider and existing-provider choices, file and paste inputs, and validation actions.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "catalog-bulk-column-mapping",
@@ -387,12 +409,45 @@
"alt": "IAM page showing a sanitized pending invitation and assigned customer role.",
"status": "pending-sanitized-user"
},
+ {
+ "id": "administration-roles-list",
+ "file": "media/screenshots/iam-roles-list.png",
+ "sourceFile": "media/screenshots/source/iam-roles-list.png",
+ "article": "/docs/create-and-edit-roles",
+ "alt": "IAM Roles list showing system and customer Roles, member counts, Permissions, and the Create Role action.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
+ },
{
"id": "administration-roles",
- "file": "media/screenshots/role-permission-builder.png",
+ "file": "media/screenshots/iam-role-editor.png",
+ "sourceFile": "media/screenshots/source/iam-role-editor.png",
"article": "/docs/create-and-edit-roles",
- "alt": "Role editor showing a sample role name and grouped action-resource Permission selections.",
- "status": "pending-sanitized-user"
+ "alt": "Create Role page showing the Name field and grouped action-resource Permission selections.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
+ },
+ {
+ "id": "administration-role-create-result",
+ "file": "media/screenshots/iam-role-created-result.png",
+ "sourceFile": "media/screenshots/source/iam-role-created-result.png",
+ "article": "/docs/create-and-edit-roles",
+ "alt": "Saved customer Role showing one selected read Assets Permission on the Permissions tab.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
+ },
+ {
+ "id": "administration-role-delete-confirm",
+ "file": "media/screenshots/iam-role-delete-confirmation.png",
+ "sourceFile": "media/screenshots/source/iam-role-delete-confirmation.png",
+ "article": "/docs/create-and-edit-roles",
+ "alt": "Delete Role confirmation identifying the selected customer Role and warning that deletion cannot be undone.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "administration-pending-invitation",
@@ -411,9 +466,12 @@
{
"id": "personal-theme",
"file": "media/screenshots/theme-settings-light-and-dark.png",
+ "sourceFile": "media/screenshots/source/theme-settings-light-and-dark.png",
"article": "/docs/choose-a-theme",
"alt": "Theme Settings showing the available Light and Dark modes and color presets.",
- "status": "blocked-pending-sanitized-recapture"
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "administration-billing-plan",
@@ -597,9 +655,12 @@
{
"id": "assets-create-success",
"file": "media/screenshots/add-asset-success.png",
+ "sourceFile": "media/screenshots/source/add-asset-success.png",
"article": "/docs/add-an-asset",
"alt": "Asset Added confirmation showing the saved status and the View Asset, Add Another, and Done next actions.",
- "status": "pending-documentation-record"
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "assets-bulk-normalization",
@@ -617,17 +678,33 @@
},
{
"id": "asset-types-save-draft",
- "file": "media/screenshots/asset-type-save-draft-result.png",
+ "file": "media/screenshots/asset-type-draft-result.png",
+ "sourceFile": "media/screenshots/source/asset-type-draft-result.png",
"article": "/docs/create-a-custom-asset-type",
"alt": "Custom Asset Type list showing the newly saved example schema with Draft status and its available actions.",
- "status": "pending-documentation-record"
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "asset-types-publish-confirm",
"file": "media/screenshots/asset-type-publish-confirmation.png",
+ "sourceFile": "media/screenshots/source/asset-type-publish-confirmation.png",
"article": "/docs/publish-and-verify-an-asset-type",
"alt": "Asset Type publication confirmation showing the read-only consequence before the destructive action is confirmed.",
- "status": "pending-product-approval"
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
+ },
+ {
+ "id": "asset-types-delete-confirm",
+ "file": "media/screenshots/asset-type-delete-confirmation.png",
+ "sourceFile": "media/screenshots/source/asset-type-delete-confirmation.png",
+ "article": "/docs/create-a-custom-asset-type",
+ "alt": "Delete Asset Type confirmation showing the affected draft name and the permanent deletion warning.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "structures-edit",
@@ -687,31 +764,43 @@
},
{
"id": "administration-user-create",
- "file": "media/screenshots/iam-create-user.png",
+ "file": "media/screenshots/invite-user-form.png",
+ "sourceFile": "media/screenshots/source/invite-user-form.png",
"article": "/docs/invite-users-and-assign-roles",
- "alt": "Create User form showing sanitized name, email, Role selection, validation, and the Create User action.",
- "status": "pending-sanitized-user"
+ "alt": "Create User form showing the User name, Email, Role selection, and Create User action with sample values.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "administration-company-logo",
- "file": "media/screenshots/company-logo-preview.png",
+ "file": "media/screenshots/company-branding.png",
+ "sourceFile": "media/screenshots/source/company-branding.png",
"article": "/docs/manage-company-settings",
- "alt": "Organization Information showing the company logo preview and Save control with identifiers removed.",
- "status": "pending-identifier-safe-capture"
+ "alt": "Platform Customization settings showing Dark Mode Logo and Light Mode Logo upload controls.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "personal-profile-general",
- "file": "media/screenshots/profile-general-settings.png",
+ "file": "media/screenshots/profile-preferences.png",
+ "sourceFile": "media/screenshots/source/profile-preferences.png",
"article": "/docs/manage-profile-and-security",
- "alt": "Personal General settings showing name, timezone, time and date formats, avatar control, and Save action.",
- "status": "pending-identifier-safe-capture"
+ "alt": "Personal General settings showing Timezone, time and date formats, and the Profile Avatar upload control.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "personal-password",
- "file": "media/screenshots/profile-change-password.png",
+ "file": "media/screenshots/profile-security.png",
+ "sourceFile": "media/screenshots/source/profile-security.png",
"article": "/docs/manage-profile-and-security",
- "alt": "Change Password form showing password requirements and action controls with every entered value blank.",
- "status": "pending-identifier-safe-capture"
+ "alt": "Security settings showing enabled Authenticator App status and blank Current and New Password fields.",
+ "captureDate": "2026-09-04",
+ "style": "wanaware-ai-assisted-v4",
+ "status": "captured-pending-product-support-review"
},
{
"id": "personal-mfa-setup",
diff --git a/media/screenshot-placements.json b/media/screenshot-placements.json
index 20c78f0..e77815d 100644
--- a/media/screenshot-placements.json
+++ b/media/screenshot-placements.json
@@ -19,6 +19,7 @@
{ "article": "/docs/add-an-asset", "screenshotId": "assets-create-type-cards", "after": "3. Find and choose the **Asset Type**. Use **Cards** when the icon and description help distinguish similar types, or switch to **List** to scan names in a compact table. **All**, **Global**, and **Custom** filter the picker; they do not change the saved Asset." },
{ "article": "/docs/add-an-asset", "screenshotId": "assets-create-type-list", "after": "The Cards view keeps each Asset Type's icon and explanation visible. The blue outline and check mark identify the current selection." },
{ "article": "/docs/add-an-asset", "screenshotId": "assets-create", "after": "7. Complete the required type-specific fields. For a catalog-backed field, select an existing catalog entry rather than typing a near-duplicate." },
+ { "article": "/docs/add-an-asset", "screenshotId": "assets-create-success", "after": "**Expected result:** WanAware displays **Asset Added!** and identifies whether the record was added to Inventory or Discovery." },
{ "article": "/docs/bulk-upload-assets", "screenshotId": "assets-bulk-import", "after": "2. Select **+ Add Asset → Add Bulk Asset**." },
{ "article": "/docs/review-discovery-and-move-assets-to-inventory", "screenshotId": "assets-discovery-move", "after": "7. Select **Move To Inventory**." },
{ "article": "/docs/review-discovery-and-move-assets-to-inventory", "screenshotId": "assets-discovery-confirm", "after": "8. Confirm the action when prompted." },
@@ -39,9 +40,28 @@
{ "article": "/docs/create-a-custom-asset-type", "screenshotId": "asset-types-list", "after": "2. Select **+ Create New Asset Type**." },
{ "article": "/docs/create-a-custom-asset-type", "screenshotId": "asset-types-start", "after": "3. Choose one starting option:" },
+ { "article": "/docs/create-a-custom-asset-type", "screenshotId": "asset-types-save-draft", "after": "**Expected result:** The Asset Type appears in the list with **Draft** status." },
+ { "article": "/docs/create-a-custom-asset-type", "screenshotId": "asset-types-actions", "after": "5. Open the row actions menu and confirm the actions match the Asset Type's status and your permissions. A manageable draft can show **Edit asset type** and **Publish asset type**; a published customer type shows **View asset type** instead." },
+ { "article": "/docs/create-a-custom-asset-type", "screenshotId": "asset-types-delete-confirm", "after": "5. Read the permanent-deletion warning and select **Delete** only when the displayed Asset Type is the intended unused draft." },
{ "article": "/docs/configure-asset-type-sections-and-fields", "screenshotId": "asset-types-fields", "after": "3. Confirm its **Name** and **Description**." },
{ "article": "/docs/configure-asset-type-sections-and-fields", "screenshotId": "asset-types-field-types", "after": "6. Give each field a customer-facing label and choose its supported input type." },
{ "article": "/docs/configure-asset-type-sections-and-fields", "screenshotId": "asset-types-field-rule", "after": "8. Add dependencies only when one value legitimately controls another." },
+ { "article": "/docs/configure-asset-type-sections-and-fields", "screenshotId": "asset-types-save-draft", "after": "**Expected result:** The saved draft reopens with the intended sections, field order, dependencies, and catalog support." },
+ { "article": "/docs/publish-and-verify-an-asset-type", "screenshotId": "asset-types-publish-confirm", "after": "6. Read the confirmation, including the read-only consequence." },
+ { "article": "/docs/create-a-custom-service-catalog", "screenshotId": "catalog-workspace", "after": "3. Confirm the selected type is the intended draft." },
+ { "article": "/docs/create-a-custom-service-catalog", "screenshotId": "catalog-entry", "after": "7. Add only approved specifications or attributes." },
+ { "article": "/docs/add-catalog-entries-and-compatibility", "screenshotId": "catalog-components", "after": "8. Add the available specifications and catalog attributes." },
+ { "article": "/docs/prepare-a-service-catalog-bulk-upload-file", "screenshotId": "catalog-bulk-import-choice", "after": " - **Models or services for existing providers** when every child row belongs to an existing provider ID." },
+ { "article": "/docs/bulk-upload-service-catalog-entries", "screenshotId": "catalog-bulk-import-choice", "after": "2. Choose the correct option under **What are you adding?**" },
+ { "article": "/docs/choose-a-theme", "screenshotId": "personal-theme", "after": "3. Under **Assigned Themes** or **Color Themes**, select the intended preset." },
+ { "article": "/docs/create-and-edit-roles", "screenshotId": "administration-roles-list", "after": "1. Open **Administration → IAM → Roles**." },
+ { "article": "/docs/create-and-edit-roles", "screenshotId": "administration-roles", "after": "4. In **Permissions**, expand each product area and select the required actions." },
+ { "article": "/docs/create-and-edit-roles", "screenshotId": "administration-role-create-result", "after": "**Expected result:** The Role opens or appears in the Roles list with the selected Permissions." },
+ { "article": "/docs/create-and-edit-roles", "screenshotId": "administration-role-delete-confirm", "after": "4. Confirm that the dialog names the intended customer Role and states that deletion cannot be undone." },
+ { "article": "/docs/invite-users-and-assign-roles", "screenshotId": "administration-user-create", "after": "5. Under **Roles**, select at least one approved Role. If none is selected, the form reports **Select at least one role**." },
+ { "article": "/docs/manage-company-settings", "screenshotId": "administration-company-logo", "after": "5. Preview logo cropping and contrast before accepting an uploaded image." },
+ { "article": "/docs/manage-profile-and-security", "screenshotId": "personal-profile-general", "after": "4. To change your avatar, select **Change avatar** and choose a supported image no larger than 1 MB." },
+ { "article": "/docs/manage-profile-and-security", "screenshotId": "personal-password", "after": "2. In **Change Password**, enter your **Current Password**." },
{ "article": "/docs/create-and-manage-structures", "screenshotId": "structures-hierarchy", "after": "1. Open **Functions → Structures**." },
{ "article": "/docs/create-and-manage-structures", "screenshotId": "structures-add", "after": "4. Enter a clear **Name**." },
diff --git a/media/screenshots/add-asset-input-state.png b/media/screenshots/add-asset-input-state.png
new file mode 100644
index 0000000..a841ca6
Binary files /dev/null and b/media/screenshots/add-asset-input-state.png differ
diff --git a/media/screenshots/add-asset-success.png b/media/screenshots/add-asset-success.png
new file mode 100644
index 0000000..8ca5651
Binary files /dev/null and b/media/screenshots/add-asset-success.png differ
diff --git a/media/screenshots/asset-type-actions-menu.png b/media/screenshots/asset-type-actions-menu.png
new file mode 100644
index 0000000..c376593
Binary files /dev/null and b/media/screenshots/asset-type-actions-menu.png differ
diff --git a/media/screenshots/asset-type-delete-confirmation.png b/media/screenshots/asset-type-delete-confirmation.png
new file mode 100644
index 0000000..1bead23
Binary files /dev/null and b/media/screenshots/asset-type-delete-confirmation.png differ
diff --git a/media/screenshots/asset-type-draft-result.png b/media/screenshots/asset-type-draft-result.png
new file mode 100644
index 0000000..bb6fe7e
Binary files /dev/null and b/media/screenshots/asset-type-draft-result.png differ
diff --git a/media/screenshots/asset-type-publish-confirmation.png b/media/screenshots/asset-type-publish-confirmation.png
new file mode 100644
index 0000000..23875c8
Binary files /dev/null and b/media/screenshots/asset-type-publish-confirmation.png differ
diff --git a/media/screenshots/catalog-bulk-import-choice.png b/media/screenshots/catalog-bulk-import-choice.png
new file mode 100644
index 0000000..2cd6473
Binary files /dev/null and b/media/screenshots/catalog-bulk-import-choice.png differ
diff --git a/media/screenshots/company-branding.png b/media/screenshots/company-branding.png
new file mode 100644
index 0000000..9f41cae
Binary files /dev/null and b/media/screenshots/company-branding.png differ
diff --git a/media/screenshots/iam-role-created-result.png b/media/screenshots/iam-role-created-result.png
new file mode 100644
index 0000000..a774304
Binary files /dev/null and b/media/screenshots/iam-role-created-result.png differ
diff --git a/media/screenshots/iam-role-delete-confirmation.png b/media/screenshots/iam-role-delete-confirmation.png
new file mode 100644
index 0000000..0d519b1
Binary files /dev/null and b/media/screenshots/iam-role-delete-confirmation.png differ
diff --git a/media/screenshots/iam-role-editor.png b/media/screenshots/iam-role-editor.png
new file mode 100644
index 0000000..575ea88
Binary files /dev/null and b/media/screenshots/iam-role-editor.png differ
diff --git a/media/screenshots/iam-roles-list.png b/media/screenshots/iam-roles-list.png
new file mode 100644
index 0000000..839861c
Binary files /dev/null and b/media/screenshots/iam-roles-list.png differ
diff --git a/media/screenshots/invite-user-form.png b/media/screenshots/invite-user-form.png
new file mode 100644
index 0000000..96c3c6c
Binary files /dev/null and b/media/screenshots/invite-user-form.png differ
diff --git a/media/screenshots/profile-preferences.png b/media/screenshots/profile-preferences.png
new file mode 100644
index 0000000..3e811cf
Binary files /dev/null and b/media/screenshots/profile-preferences.png differ
diff --git a/media/screenshots/profile-security.png b/media/screenshots/profile-security.png
new file mode 100644
index 0000000..c287981
Binary files /dev/null and b/media/screenshots/profile-security.png differ
diff --git a/media/screenshots/service-catalog-entry-form.png b/media/screenshots/service-catalog-entry-form.png
new file mode 100644
index 0000000..012c24c
Binary files /dev/null and b/media/screenshots/service-catalog-entry-form.png differ
diff --git a/media/screenshots/service-catalog-models-components.png b/media/screenshots/service-catalog-models-components.png
new file mode 100644
index 0000000..1090aca
Binary files /dev/null and b/media/screenshots/service-catalog-models-components.png differ
diff --git a/media/screenshots/service-catalog-workspace.png b/media/screenshots/service-catalog-workspace.png
new file mode 100644
index 0000000..b7e6048
Binary files /dev/null and b/media/screenshots/service-catalog-workspace.png differ
diff --git a/media/screenshots/source/add-asset-input-state.png b/media/screenshots/source/add-asset-input-state.png
new file mode 100644
index 0000000..98b7034
Binary files /dev/null and b/media/screenshots/source/add-asset-input-state.png differ
diff --git a/media/screenshots/source/add-asset-success.png b/media/screenshots/source/add-asset-success.png
new file mode 100644
index 0000000..c4b063f
Binary files /dev/null and b/media/screenshots/source/add-asset-success.png differ
diff --git a/media/screenshots/source/asset-type-actions-menu.png b/media/screenshots/source/asset-type-actions-menu.png
new file mode 100644
index 0000000..7f02aae
Binary files /dev/null and b/media/screenshots/source/asset-type-actions-menu.png differ
diff --git a/media/screenshots/source/asset-type-delete-confirmation.png b/media/screenshots/source/asset-type-delete-confirmation.png
new file mode 100644
index 0000000..105cc71
Binary files /dev/null and b/media/screenshots/source/asset-type-delete-confirmation.png differ
diff --git a/media/screenshots/source/asset-type-draft-result.png b/media/screenshots/source/asset-type-draft-result.png
new file mode 100644
index 0000000..1268512
Binary files /dev/null and b/media/screenshots/source/asset-type-draft-result.png differ
diff --git a/media/screenshots/source/asset-type-publish-confirmation.png b/media/screenshots/source/asset-type-publish-confirmation.png
new file mode 100644
index 0000000..15e1238
Binary files /dev/null and b/media/screenshots/source/asset-type-publish-confirmation.png differ
diff --git a/media/screenshots/source/catalog-bulk-import-choice.png b/media/screenshots/source/catalog-bulk-import-choice.png
new file mode 100644
index 0000000..a53d63e
Binary files /dev/null and b/media/screenshots/source/catalog-bulk-import-choice.png differ
diff --git a/media/screenshots/source/company-branding.png b/media/screenshots/source/company-branding.png
new file mode 100644
index 0000000..bbe9bf5
Binary files /dev/null and b/media/screenshots/source/company-branding.png differ
diff --git a/media/screenshots/source/iam-role-created-result.png b/media/screenshots/source/iam-role-created-result.png
new file mode 100644
index 0000000..57acfe6
Binary files /dev/null and b/media/screenshots/source/iam-role-created-result.png differ
diff --git a/media/screenshots/source/iam-role-delete-confirmation.png b/media/screenshots/source/iam-role-delete-confirmation.png
new file mode 100644
index 0000000..42aa103
Binary files /dev/null and b/media/screenshots/source/iam-role-delete-confirmation.png differ
diff --git a/media/screenshots/source/iam-role-editor.png b/media/screenshots/source/iam-role-editor.png
new file mode 100644
index 0000000..2f471c1
Binary files /dev/null and b/media/screenshots/source/iam-role-editor.png differ
diff --git a/media/screenshots/source/iam-roles-list.png b/media/screenshots/source/iam-roles-list.png
new file mode 100644
index 0000000..a0fbe8d
Binary files /dev/null and b/media/screenshots/source/iam-roles-list.png differ
diff --git a/media/screenshots/source/invite-user-form.png b/media/screenshots/source/invite-user-form.png
new file mode 100644
index 0000000..3e6e7ab
Binary files /dev/null and b/media/screenshots/source/invite-user-form.png differ
diff --git a/media/screenshots/source/profile-preferences.png b/media/screenshots/source/profile-preferences.png
new file mode 100644
index 0000000..f781433
Binary files /dev/null and b/media/screenshots/source/profile-preferences.png differ
diff --git a/media/screenshots/source/profile-security.png b/media/screenshots/source/profile-security.png
new file mode 100644
index 0000000..b5642d4
Binary files /dev/null and b/media/screenshots/source/profile-security.png differ
diff --git a/media/screenshots/source/service-catalog-entry-form.png b/media/screenshots/source/service-catalog-entry-form.png
new file mode 100644
index 0000000..7e30bcb
Binary files /dev/null and b/media/screenshots/source/service-catalog-entry-form.png differ
diff --git a/media/screenshots/source/service-catalog-models-components.png b/media/screenshots/source/service-catalog-models-components.png
new file mode 100644
index 0000000..375ec99
Binary files /dev/null and b/media/screenshots/source/service-catalog-models-components.png differ
diff --git a/media/screenshots/source/service-catalog-workspace.png b/media/screenshots/source/service-catalog-workspace.png
new file mode 100644
index 0000000..4ebd553
Binary files /dev/null and b/media/screenshots/source/service-catalog-workspace.png differ
diff --git a/media/screenshots/source/theme-settings-light-and-dark.png b/media/screenshots/source/theme-settings-light-and-dark.png
new file mode 100644
index 0000000..a126948
Binary files /dev/null and b/media/screenshots/source/theme-settings-light-and-dark.png differ
diff --git a/media/screenshots/theme-settings-light-and-dark.png b/media/screenshots/theme-settings-light-and-dark.png
new file mode 100644
index 0000000..736e4bc
Binary files /dev/null and b/media/screenshots/theme-settings-light-and-dark.png differ
diff --git a/media/workflow-visual-coverage.json b/media/workflow-visual-coverage.json
index 219c4c2..f156b6e 100644
--- a/media/workflow-visual-coverage.json
+++ b/media/workflow-visual-coverage.json
@@ -16,14 +16,13 @@
},
{
"article": "/docs/add-an-asset",
- "status": "capture-incomplete",
+ "status": "captured",
"screenshotIds": [
"assets-create-type-cards",
"assets-create-type-list",
- "assets-create"
- ],
- "pendingScreenshotIds": ["assets-create-success"],
- "blocker": "The Asset Added confirmation requires a documentation-only record to be created and cleaned up."
+ "assets-create",
+ "assets-create-success"
+ ]
},
{
"article": "/docs/add-an-integration",
@@ -37,8 +36,12 @@
},
{
"article": "/docs/add-catalog-entries-and-compatibility",
- "status": "capture-blocked",
- "blocker": "The current sample workspace does not expose a writable verified catalog flow."
+ "status": "capture-incomplete",
+ "screenshotIds": [
+ "catalog-components"
+ ],
+ "pendingScreenshotIds": ["catalog-compatibility", "catalog-save-result"],
+ "blocker": "The released catalog details are captured, but compatibility selection and a safe saved result still need documentation-only records."
},
{
"article": "/docs/attach-collections-to-structures",
@@ -86,44 +89,64 @@
},
{
"article": "/docs/bulk-upload-service-catalog-entries",
- "status": "capture-blocked",
- "blocker": "Catalog bulk upload reports that its backing service is not connected."
+ "status": "capture-incomplete",
+ "screenshotIds": [
+ "catalog-bulk-import-choice"
+ ],
+ "pendingScreenshotIds": [
+ "catalog-bulk-column-mapping",
+ "catalog-bulk-review-results",
+ "catalog-bulk-completion"
+ ],
+ "blocker": "The import choice is captured, but the backing service must complete a safe end-to-end job before mapping, review, and completion can be captured."
},
{
"article": "/docs/choose-a-theme",
- "status": "capture-blocked",
- "blocker": "The authenticated portal session locked before the Theme Settings panel could be captured."
+ "status": "captured",
+ "screenshotIds": [
+ "personal-theme"
+ ]
},
{
"article": "/docs/configure-asset-type-sections-and-fields",
- "status": "capture-incomplete",
+ "status": "captured",
"screenshotIds": [
"asset-types-fields",
"asset-types-field-types",
- "asset-types-field-rule"
- ],
- "pendingScreenshotIds": ["asset-types-save-draft"],
- "blocker": "The saved-draft checkpoint needs a documentation-only draft record."
+ "asset-types-field-rule",
+ "asset-types-save-draft"
+ ]
},
{
"article": "/docs/create-a-custom-asset-type",
- "status": "capture-incomplete",
+ "status": "captured",
"screenshotIds": [
"asset-types-list",
- "asset-types-start"
- ],
- "pendingScreenshotIds": ["asset-types-save-draft"],
- "blocker": "The Draft result needs a documentation-only Asset Type that can be removed after capture."
+ "asset-types-start",
+ "asset-types-actions",
+ "asset-types-save-draft",
+ "asset-types-delete-confirm"
+ ]
},
{
"article": "/docs/create-a-custom-service-catalog",
- "status": "capture-blocked",
- "blocker": "The current sample workspace does not expose a writable verified catalog flow."
+ "status": "capture-incomplete",
+ "screenshotIds": [
+ "catalog-workspace",
+ "catalog-entry"
+ ],
+ "pendingScreenshotIds": ["catalog-save-result"],
+ "blocker": "The catalog workspace and entry form are captured; a safe saved-entry result still requires a disposable documentation record."
},
{
"article": "/docs/create-and-edit-roles",
- "status": "capture-blocked",
- "blocker": "The authenticated portal session locked before the safe unsaved Role editor could be captured."
+ "status": "captured",
+ "screenshotIds": [
+ "administration-roles-list",
+ "administration-roles",
+ "administration-role-create-result",
+ "administration-role-delete-confirm"
+ ]
},
{
"article": "/docs/create-and-manage-structures",
@@ -175,8 +198,10 @@
},
{
"article": "/docs/invite-users-and-assign-roles",
- "status": "capture-blocked",
- "blocker": "The authenticated portal session locked before a sanitized IAM state could be captured."
+ "status": "capture-incomplete",
+ "screenshotIds": ["administration-user-create"],
+ "pendingScreenshotIds": ["administration-iam"],
+ "blocker": "The safe Create User form is captured; a sanitized sent-invitation result still requires an approved documentation-only address."
},
{
"article": "/docs/manage-asset-and-structure-tags",
@@ -188,8 +213,10 @@
},
{
"article": "/docs/manage-company-settings",
- "status": "capture-blocked",
- "blocker": "The authenticated portal session locked before identifier-safe settings could be captured."
+ "status": "capture-incomplete",
+ "screenshotIds": ["administration-company-logo"],
+ "pendingScreenshotIds": ["administration-company-profile"],
+ "blocker": "The logo controls are captured without workspace identifiers; a safe Organization Information capture still requires approved sample values."
},
{
"article": "/docs/manage-payment-methods",
@@ -203,8 +230,16 @@
},
{
"article": "/docs/manage-profile-and-security",
- "status": "capture-blocked",
- "blocker": "The authenticated portal session locked before identifier-safe profile controls could be captured."
+ "status": "capture-incomplete",
+ "screenshotIds": [
+ "personal-profile-general",
+ "personal-password"
+ ],
+ "pendingScreenshotIds": [
+ "personal-mfa-setup",
+ "personal-recovery-codes"
+ ],
+ "blocker": "General preferences and password controls are captured without identifiers; the active account is already enrolled in MFA, and recovery codes must never appear in documentation media."
},
{
"article": "/docs/manage-site-details",
@@ -224,13 +259,19 @@
},
{
"article": "/docs/prepare-a-service-catalog-bulk-upload-file",
- "status": "capture-blocked",
- "blocker": "Catalog bulk upload reports that its backing service is not connected."
+ "status": "capture-incomplete",
+ "screenshotIds": [
+ "catalog-bulk-import-choice"
+ ],
+ "pendingScreenshotIds": ["catalog-bulk-column-mapping"],
+ "blocker": "The import choices and template entry point are captured; end-to-end service verification is still required before publishing the workflow."
},
{
"article": "/docs/publish-and-verify-an-asset-type",
- "status": "capture-blocked",
- "blocker": "Publication confirmation must be recaptured after the signed-in session is unlocked; no draft is published for a screenshot."
+ "status": "capture-incomplete",
+ "screenshotIds": ["asset-types-publish-confirm"],
+ "pendingScreenshotIds": ["asset-types-lifecycle"],
+ "blocker": "The publication warning is captured; no Asset Type is published solely to obtain documentation media."
},
{
"article": "/docs/refresh-integration-data",
diff --git a/package.json b/package.json
index 131a337..a94b9b3 100644
--- a/package.json
+++ b/package.json
@@ -5,6 +5,7 @@
"description": "Content-quality checks for the public WanAware customer knowledge base",
"scripts": {
"check": "node scripts/validate-content.mjs",
+ "check:release": "DOCS_RELEASE_MODE=live node scripts/validate-content.mjs",
"check:media": "node scripts/validate-media-online.mjs",
"media:frame": "node scripts/frame-screenshot.mjs",
"media:enhance": "node scripts/enhance-screenshot.mjs",
diff --git a/scripts/validate-content.mjs b/scripts/validate-content.mjs
index e7df82d..b5b5697 100644
--- a/scripts/validate-content.mjs
+++ b/scripts/validate-content.mjs
@@ -6,6 +6,7 @@ import process from 'node:process';
const root = process.cwd();
const docsRoot = join(root, 'docs');
const errors = [];
+const releaseMode = process.env.DOCS_RELEASE_MODE === 'live';
function walk(directory) {
return readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {
@@ -85,11 +86,21 @@ for (const file of markdownFiles) {
if (!frontmatter[1].includes(field)) fail(file, `frontmatter is missing ${field}`);
}
- if (!/^# .+/m.test(source.slice(frontmatter[0].length))) {
- fail(file, 'missing an H1 heading');
+ const customerBody = source.slice(frontmatter[0].length).replace(//g, '');
+ for (const [index, line] of customerBody.split('\n').entries()) {
+ if (!/^\|.*\|$/.test(line)) continue;
+ const columnCount = line.split('|').length - 2;
+ if (columnCount > 4) {
+ fail(file, `line ${index + 1} has ${columnCount} table columns; use four or fewer for narrow ReadMe layouts`);
+ }
+ }
+
+ if (/^# .+/m.test(customerBody)) {
+ fail(file, 'body H1 duplicates the title that ReadMe renders from frontmatter; begin body sections at H2');
}
const isCategory = file.endsWith('/index.md');
+ const isHidden = /^hidden:\s*true$/m.test(frontmatter[1]);
if (!isCategory) {
const metadata = source.match(//);
if (!metadata) {
@@ -126,14 +137,27 @@ for (const file of markdownFiles) {
}
}
+ if (releaseMode && !isHidden && releaseStatus !== 'ready') {
+ fail(file, 'visible pages must have release-status ready before publishing to v1.0');
+ }
+
const contentType = metadataValue(metadata[1], 'content-type');
if (contentType === 'workflow' || contentType === 'quickstart') {
for (const label of ['**Outcome:**', '**For:**', '**Permission:**', '**Time:**', '**Changes made:**']) {
if (!source.includes(label)) fail(file, `workflow is missing ${label}`);
}
- for (const heading of ['## If you\'re stuck', '## Before you start', '## Learn, show me, do it', '## Get help']) {
+ for (const heading of ['## If you\'re stuck', '## Before you start', '## Learn and continue', '## Next steps', '## Get help']) {
if (!source.includes(heading)) fail(file, `workflow is missing ${heading}`);
}
+ if (!source.includes('**In WanAware:**')) {
+ fail(file, 'workflow is missing an exact in-product navigation path');
+ }
+ if (/\*\*Show me:\*\*/.test(source)) {
+ fail(file, 'workflow exposes an unapproved Show me placeholder');
+ }
+ if (/\b(?:publication blocker|pending (?:workflow )?verification|pending (?:Product|Support|approval)|until .* approved)\b/i.test(customerBody)) {
+ fail(file, 'workflow exposes internal publication or approval language');
+ }
if (!/^## (?:Field|Option|Starting option|Status and action|View and control|Field and relationship|Field and checkpoint|Page and checkpoint|Action-safety).+guide$/m.test(source)) {
fail(file, 'workflow is missing a concrete field, option, action, or checkpoint guide');
}
@@ -145,7 +169,7 @@ for (const file of markdownFiles) {
fail(file, 'workflow changes data but is missing undo or recovery guidance');
}
if (!source.includes('support@wanaware.com')) fail(file, 'workflow is missing the support handoff');
- const vagueInstruction = source.match(/\b(?:complete the prompts|fill out (?:the )?descriptive fields|select the appropriate option|when available|available save action|available collection|available option)\b/i);
+ const vagueInstruction = source.match(/\b(?:complete the prompts|complete (?:all |the )?fields|fill (?:in|out) (?:the )?fields|fill out (?:the )?descriptive fields|select (?:the |an )?appropriate (?:option|parent)|choose (?:the |an )?appropriate option|follow the prompts|when available|available save action|available collection|available option)\b/i);
if (vagueInstruction) fail(file, `contains vague instructional wording: ${vagueInstruction[0]}`);
const permission = metadataValue(metadata[1], 'permission') || '';
@@ -563,6 +587,9 @@ if (workflowVisualCoverage && screenshotManifest) {
if (/^release-status:\s*ready$/m.test(source)) {
fail(workflowVisualCoverageFile, `${label} cannot have incomplete or blocked action visuals when its article is release-ready`);
}
+ if (releaseMode && !/^hidden:\s*true$/m.test(source)) {
+ fail(workflowVisualCoverageFile, `${label} must be captured or hidden before publishing to v1.0`);
+ }
}
}
for (const slug of workflowSlugs) {
@@ -570,6 +597,19 @@ if (workflowVisualCoverage && screenshotManifest) {
}
}
+const publicationGateFile = join(root, 'integration/publication-gate.json');
+const publicationGate = parseJson(publicationGateFile);
+if (releaseMode && publicationGate) {
+ if (publicationGate.status !== 'ready-for-release') {
+ fail(publicationGateFile, 'status must be ready-for-release before publishing to v1.0');
+ }
+ for (const [index, check] of (publicationGate.blockingChecks || []).entries()) {
+ if (check.status !== 'passing') {
+ fail(publicationGateFile, `blocking check ${index + 1} is not passing: ${check.check}`);
+ }
+ }
+}
+
const screenshotPlacementsFile = join(root, 'media/screenshot-placements.json');
const screenshotPlacements = parseJson(screenshotPlacementsFile);
if (screenshotPlacements && screenshotManifest) {