Skip to content

QUA-1518: Update the Field Status structure files#1072

Merged
RafaelOsiro merged 5 commits intomainfrom
qua-1518-update-the-field-status-structure-files
Mar 20, 2026
Merged

QUA-1518: Update the Field Status structure files#1072
RafaelOsiro merged 5 commits intomainfrom
qua-1518-update-the-field-status-structure-files

Conversation

@RafaelOsiro
Copy link
Contributor

@RafaelOsiro RafaelOsiro commented Mar 16, 2026

Overview

This PR standardizes the Field Status documentation section by restructuring its navigation, improving cross-page linking behavior, and aligning content with the current state of the frontend and backend codebases.

Key Changes

  • Navigation restructure: Reordered the Field Status sidebar to Overview → API → FAQ → Deep Dive → Managing Field Status, and renamed "Concepts" to "Deep Dive" for clarity.
  • Overview page reorganization: Split the API and FAQ links into their own table, separate from the Deep Dive and Managing sections.
  • Link behavior: Internal links within the overview page navigate in the same tab, while all cross-reference links inside Deep Dive and Managing pages now open in a new browser tab ({:target="_blank"}).
  • Masked → Missing transition: Added the missing Masked → Missing automatic transition to the lifecycle diagram (mermaid) and transition details table, matching the backend behavior where a masked field not found during profiling is marked as missing.
  • Status indicator icons: Corrected the icon descriptions in the Status Types page to match the frontend implementation — Active (mdi-check-circle), Missing (mdi-alert-circle), Excluded (mdi-eye-off).
  • FAQ updates: Updated the bulk operations answer to mention UI support (not just API), and added a new FAQ entry documenting that excluded and missing fields cannot be masked directly (blocked transitions).

Screenshots

N/A — All changes are textual (navigation structure, markdown content, and mermaid diagrams). No new screenshots required.

Reorder Field Status section to Overview → API → FAQ → Deep Dive →
Managing Field Status. Rename "Concepts" to "Deep Dive" and split
API/FAQ into their own table in the overview page.
… (QUA-1518)

Add {:target="_blank"} to internal links in managing and concept
pages so they open in a new browser tab, while overview links
continue to navigate in the same tab.
Add missing Masked → Missing transition to lifecycle diagram and
table. Fix status indicator icons to match frontend (mdi-check-circle,
mdi-alert-circle, mdi-eye-off). Update FAQ with bulk UI support and
add entry about blocked status transitions.
@RafaelOsiro RafaelOsiro self-assigned this Mar 16, 2026
@RafaelOsiro RafaelOsiro added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 16, 2026
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 16, 2026 22:24
- Rename "Field Status" section to "Status" and entry page to "Getting Started"
- Reorder nav items: Getting Started → Deep Dive → Managing → API → FAQ
- Rename "Managing Field Status" nav label to "Managing"
- Clarify across pages that status changes occur during profile operations, not in real time
- Remove Scenario 4 (temporary outage) from understanding-field-status.md
@RafaelOsiro RafaelOsiro merged commit c4fff35 into main Mar 20, 2026
1 check passed
@RafaelOsiro RafaelOsiro deleted the qua-1518-update-the-field-status-structure-files branch March 20, 2026 21:50
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants