Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add status label within documentation, not just navigation #5349

Closed
petesfrench opened this issue Sep 13, 2024 · 4 comments · Fixed by #5353
Closed

Add status label within documentation, not just navigation #5349

petesfrench opened this issue Sep 13, 2024 · 4 comments · Fixed by #5353
Assignees
Labels
Bug 🐛 P3 Triaged Issue has been reviewed as part of legacy backlog grooming (project P3). Triaged: new architecture Triaged, to be addressed in new architecture of the design system Triaged: v4 Triaged, to be implemented as part of Vanilla v4

Comments

@petesfrench
Copy link
Contributor

petesfrench commented Sep 13, 2024

Describe the bug
I realize this isn't a bug, but didn't know where else to file it.

In the side navigation there are visual indicators as to where new features exists. However there is no information in the documentation about which specific feature is new. You can of course look in the changelog, but then what is the point of the status label to begin with.

To Reproduce

Expected behavior

A clear indication as to what is new, updated, deprecated etc

Screenshots

How it currently is (no indication that the wrapped class is new):
image

How I think it should look (with some kind of visual indicator):
image

Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/WD-14923.

This message was autogenerated

@petesfrench
Copy link
Contributor Author

Also, I link to the relevant example would be nice to have in the docs

@pastelcyborg pastelcyborg self-assigned this Sep 17, 2024
@pastelcyborg
Copy link
Contributor

This is a good call - will look into this.

@bartaz bartaz added P3 Triaged Issue has been reviewed as part of legacy backlog grooming (project P3). Triaged: v4 Triaged, to be implemented as part of Vanilla v4 Triaged: new architecture Triaged, to be addressed in new architecture of the design system labels Sep 25, 2024
@bartaz
Copy link
Member

bartaz commented Sep 25, 2024

We can have a quick fix (and manually manage those) in current docs.
But it's something to consider for future as well, how new architecture and documentation can make managing this easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug 🐛 P3 Triaged Issue has been reviewed as part of legacy backlog grooming (project P3). Triaged: new architecture Triaged, to be addressed in new architecture of the design system Triaged: v4 Triaged, to be implemented as part of Vanilla v4
Projects
None yet
3 participants