adobe / adobe/spectrum-web-components

[doc]: Help text documentation is inaccurate

Open
#5,687 1 comment 0 reactions 0 assignees View on GitHub
a11y Component:Documentation Component:Help text triage
Dominant language
TypeScript
Stars
1.5k
Forks
262
Avg merge
3d 10h
Merged PRs (30d)
68

Description

### Code of conduct

- [x] I agree to follow this project's code of conduct.

### Description of issue

The doc at https://opensource.adobe.com/spectrum-web-components/components/help-text/#negative is incorrect.

It appears that the slot for the negative help text should be `negative-help-text` as opposed to `help-text-negative` and the example is not really showing the negative help text as it stands. Manually changing it in the inspector seems to show show the expect color and text _Passwords must be at least 8 characters_

### Would you like to track this issue in Jira?

- [x] Yes, please tell me the ticket number!

Contributor guide

Open the contributing guide

Research direction

Open the Help Text documentation at the provided URL and inspect the #negative section. Verify the negative help-text slot name and the example against the expected color and text, “Passwords must be at least 8 characters.” Done means the documentation uses the correct slot and demonstrates negative help text accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.