Skip to content

[SC-16822] Documentation: Risk Tiering#1425

Merged
juanmleng merged 3 commits into
mainfrom
juan/sc-16822/documentation-risk-tiering
Jul 23, 2026
Merged

[SC-16822] Documentation: Risk Tiering#1425
juanmleng merged 3 commits into
mainfrom
juan/sc-16822/documentation-risk-tiering

Conversation

@juanmleng

@juanmleng juanmleng commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Adds a new Risk tiering section to the user guide, documenting the Risk Tier Engine end to end. Previously there was no user documentation for risk tiering; this section fills that gap.

It contains four pages:

  • Working with risk tiering — concepts, the Draft → Active → Archived lifecycle, roles, and where to find each feature.
  • Manage risk tier templates — create, publish, version, duplicate, archive, restore, and delete templates.
  • Configure risk tier calculation — scoring levels, risk factors, components and scoring rules, thresholds, the scorecard and risk matrix methods, and override rules.
  • Manage risk tier assessments — create, review, publish, and version assessments on inventory records, plus stale-assessment handling and the Assessed Risk Tier field.

The section is wired into the guide sidebar (after Inventory), the Guides landing page, and the footer navigation.

How to test

Automated tests: none — this is a documentation-only change.

Preview:
Risk tiering section

To preview locally instead:

  1. cd site && quarto preview --profile development
  2. Confirm a new Risk tiering section appears under Guides, immediately after Inventory, with the overview page and three how-tos nested beneath it.
  3. Open each of the four pages and confirm they render, the callouts display, and the cross-reference links between pages resolve.
  4. On the Guides landing page, confirm the Risk tiering card grid appears and links work.

What needs special review?

Product accuracy of the documented behavior — in particular the lifecycle statuses (Draft/Active/Archived), template and assessment versioning, and stale-assessment handling (there is no in-place "use latest template" action; a new version is created to move onto the latest active template).

Dependencies, breaking changes, and deployment notes

None. Documentation-only change with no companion PR, migrations, or environment variables.

Release notes

Documents the Risk Tier Engine: how to create and publish risk tier templates, configure tier calculation with the scorecard or risk matrix method, and run risk tier assessments on inventory records. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

Add a new Risk tiering section under Guides covering the Risk Tier Engine:
an overview page plus how-tos for managing templates, configuring tier
calculation, and managing assessments. Wire the section into the guide
sidebar, the Guides landing page, and the footer navigation.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@juanmleng juanmleng self-assigned this Jul 22, 2026
@juanmleng juanmleng added the documentation Improvements or additions to documentation label Jul 22, 2026
@juanmleng
juanmleng marked this pull request as ready for review July 22, 2026 16:17
@juanmleng
juanmleng requested review from Copilot, emmavdh and kristof87 and removed request for Copilot July 22, 2026 16:19
@juanmleng
juanmleng requested a review from cachafla July 22, 2026 16:19

@cachafla cachafla left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great 🙌

@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR introduces comprehensive documentation for the new risk tiering feature. It adds multiple new QMD pages that detail how to configure risk tier calculations, manage risk tier templates and assessments, and work with risk tiering overall. In addition, the navigation structure (including the sidebar and main site configuration) has been updated to include links to these new risk tiering guides. The changes ensure that users have clear step-by-step instructions and reference materials for setting up scoring levels, risk factors, override rules, and the complete lifecycle of risk tier templates and assessments. The diff also refines existing documentation mappings to remove obsolete entries and present updated navigation paths for risk tiering content.

Test Suggestions

  • Verify that all new risk tiering documentation pages render correctly and that content is formatted as expected.
  • Test the updated navigation menus (_quarto.yml and _sidebar.yaml) to ensure that the new risk tiering links appear correctly and are functional.
  • Check that all internal links within the risk tiering guides correctly reference the appropriate sections and other related documentation pages.
  • Review the chatbot product map file to confirm that the risk tiering links are accurately displayed with the correct section details.

@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@juanmleng
juanmleng added this pull request to the merge queue Jul 23, 2026
Merged via the queue into main with commit c4d0875 Jul 23, 2026
5 of 6 checks passed
@juanmleng
juanmleng deleted the juan/sc-16822/documentation-risk-tiering branch July 23, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants