Skip to content

improvement(charts): a guideline with an annotated anatomy and the real states - #1227

Open
Cuervino wants to merge 1 commit into
development/1.0from
improvement/CUI-55-chart-guideline
Open

Cuervino wants to merge 1 commit into
development/1.0from
improvement/CUI-55-chart-guideline

Conversation

@Cuervino

@Cuervino Cuervino commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

The Charts guideline was a stub: two short sections, a WIP placeholder and a TODO, no example. The library ships four chart components and over fifty stories, and nothing said which form to reach for or what the parts are called.

When to use a chart, and when a number, a ProgressBar or a table says it better. Plus the forms that read poorly, which is why none of them are in the library.

Anatomy. Every part named over two annotated diagrams, the frame and the hover layer. Hovering a numbered callout highlights the part it names and spells it out under the diagram.

The anatomy follows what the components do rather than what a chart usually looks like, which corrected two things: the value axis sits on the right (orientation="right"), and the unit belongs to the title since formatTickValue produces bare numbers.

Data terms and states. The three non-nominal states are rendered by the real Barchart, not drawn. That is what made the gap visible: a query that returns nothing draws a bare frame, and nothing tells it apart from a failure. The section describes the behaviour as it stands rather than a target one.

CUI-55

@bert-e

bert-e commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Hello cuervino,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options
name description privileged authored
/after_pull_request Wait for the given pull request id to be merged before continuing with the current one.
/bypass_author_approval Bypass the pull request author's approval
/bypass_build_status Bypass the build and test status
/bypass_commit_size Bypass the check on the size of the changeset TBA
/bypass_incompatible_branch Bypass the check on the source branch prefix
/bypass_jira_check Bypass the Jira issue check
/bypass_peer_approval Bypass the pull request peers' approval
/bypass_leader_approval Bypass the pull request leaders' approval
/bypass_source_branch_lineage Bypass the cross-branch contamination check
/approve Instruct Bert-E that the author has approved the pull request. ✍️
/create_pull_requests Allow the creation of integration pull requests.
/create_integration_branches Allow the creation of integration branches.
/no_octopus Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
/unanimity Change review acceptance criteria from one reviewer at least to all reviewers
/wait Instruct Bert-E not to run until further notice.
Available commands
name description privileged
/help Print Bert-E's manual in the pull request.
/status Print Bert-E's current status in the pull request.
/clear Remove all comments from Bert-E from the history TBA
/retry Re-start a fresh build TBA
/build Re-start a fresh build TBA
/force_reset Delete integration branches & pull requests, and restart merge process from the beginning.
/reset Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

@Cuervino
Cuervino requested a review from a team September 21, 2026 14:18
@bert-e

bert-e commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

…al states

The Charts guideline was a stub: two short sections, a WIP placeholder and a
TODO, no example. The library meanwhile ships four chart components and over
fifty stories with no written rule, so nothing said which form to reach for or
what the parts are called.

Cover when a chart is the right tool and when a number, a ProgressBar or a
table says it better, then name every part over two annotated diagrams, where
hovering a numbered callout highlights the part it names.

The anatomy follows what the components do rather than what a chart usually
looks like, which corrected two things: the value axis sits on the right, and
the unit belongs to the title since the ticks carry bare numbers.

The three non-nominal states are rendered by the real Barchart rather than
drawn, which is what made the gap visible: a query returning nothing draws a
bare frame, with nothing to tell it apart from a failure. The section describes
that behaviour as it stands.
@Cuervino
Cuervino force-pushed the improvement/CUI-55-chart-guideline branch from 30eb060 to 173ce83 Compare September 21, 2026 14:23

This branch has not been deployed

No deployments
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.

2 participants