Skip to content

feat(ui): uxdocs - add rendering empty and unknown values guidelines - #2071

Merged
franzheidl merged 3 commits into
mainfrom
franz-uxdocs-rendering-empty-unknown-values-2030
Oct 8, 2026
Merged

franzheidl merged 3 commits into
mainfrom
franz-uxdocs-rendering-empty-unknown-values-2030

Conversation

@franzheidl

@franzheidl franzheidl commented Oct 8, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds UX writing guidance for rendering missing or unknown values consistently across the UI.

Two rules are documented:

  • General rule: Use - - (two hyphens separated by a space) as a visual placeholder for any empty or unknown value. En and em dashes are explicitly discouraged — they look similar but carry different semantic meaning and can be silently introduced by editors with smart typography enabled.
  • Names as identifiers: In positions where a name is the primary means of identifying an item — DataGrid name columns, detail view page titles, and breadcrumb segments — fall back to the item's ID rather than - - when no name is set. Exception: verbatim metadata display (e.g. a definition list showing raw item properties) should use - - to accurately reflect that no name value exists.

Changes

  • docs/ux/ux-writing-content-design.md — new "Rendering Empty or Unknown Values" section
  • docs/ux/datagrid.md — added a bullet to "DataGrid Content and Writing" cross-referencing the new guidance

Related Issues

Closes #2067

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have made corresponding changes to the documentation (if applicable).
  • My changes generate no new warnings or errors.
  • I have created a changeset for my changes.

PR Manifesto

Review the PR Manifesto for best practises.

…uidelines (#2030)

Signed-off-by: Franz Heidl <franz.heidl@sap.com>
@changeset-bot

changeset-bot Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 72f4272

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@franzheidl franzheidl self-assigned this Oct 8, 2026
@franzheidl
franzheidl marked this pull request as ready for review October 8, 2026 13:08
Copilot AI balanced review requested due to automatic review settings October 8, 2026 13:08
@franzheidl
franzheidl requested a review from a team as a code owner October 8, 2026 13:08

Copilot AI 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.

🟡 Changes recommended

The guidance needs accessible placeholder handling and consistent wording for name versus identifier columns.

2 open findings
What changed in this PR

Adds UX guidance for consistently displaying missing or unknown values.

Changes:

  • Defines - - as the standard visual placeholder.
  • Documents ID fallback rules for missing names.
  • Cross-references the guidance from DataGrid documentation.
File Description
docs/​ux/​ux-writing-content-design.md Adds placeholder and identifier fallback guidance.
docs/​ux/​datagrid.md Applies the guidance to DataGrid cells.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Comment thread docs/ux/datagrid.md Outdated
Comment thread docs/ux/ux-writing-content-design.md
edda
edda previously approved these changes Oct 8, 2026
Signed-off-by: Franz Heidl <franz.heidl@sap.com>
@franzheidl
franzheidl merged commit f399b19 into main Oct 8, 2026
24 checks passed
@franzheidl
franzheidl deleted the franz-uxdocs-rendering-empty-unknown-values-2030 branch October 8, 2026 16:13
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-08 16:14 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task](context): clarify usage / prevent transform of "--" for empty values on the UI

4 participants