SSWConsulting / SSWConsulting/SSW.Rules

♻️ Editing Rules - Improve the helper texts for Categories and Related Rules

Open
#2,133 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

01-small Area: Frontend Type: Refactor
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

cc @Aibono1225 @adamcogan @JeanThirion @Freego1783

Hi team

Pain

I am editing a rule and found it cool that you can change its category straight on the rule view. But it's not clear how to add a second category in this view (see screenshot)

Tasks
  • 1. Change from:

    Related Category
    The related category of the rule

    to

    Category
    Select a category for this rule. Go back to add more if needed.

    Image
  • 2. Add a similar text on Related Rules. E.g.:

    Related rule
    Select a related rule. Go back to add more if needed.

    Image
  • 3. On the previous page, there is a hidden text that can't be seen under Related Rules... it's using an elipsis, but users can't see what's there. Please make sure the full text is visible

  • 4. I'd also change from:

    The URIs of rules that should be suggested based on the content of this rule.

    to

    The URIs of rules to suggest based on this rule’s content.

    Image
  • 5. Change from:

    Uri

    to

    URI

    Image
  • 6. And for consistency... change from:

    Rule thumbnail

    to

    Rule Thumbnail

    Image

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the rule view/editor described in the issue, focusing on the Categories and Related Rules fields and their previous-page display. Update the six requested labels and helper texts, ensure the full Related Rules text is visible, and verify that the wording matches the issue exactly.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
content, frontend
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.