Polish Examples

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
html
Domain
documentation

Research direction

Start by locating the Examples pages and navigation entries, then review eclipsesource/jsonforms#853 and #854 for related context. Check each listed example for consistent naming, valid initial data, working renderers, and a clearer star-renderer presentation; done means all reported issues are resolved.

Written by the indexing model from the issue text.

Description

There are multiple small issues in the Examples:

  • Name of page and entry in navigation are mostly inconsistent
  • The max length of 5 does not make any sense in the array control example. It seems weird that the example contains initial invalid data
  • Categorization example is currently broken. It only renders No applicable renderer found.
  • Inferring a UI schema and Inferring both schemata are partially broken. For one of the elements they also render No applicable renderer found.
  • The star renderer in custom control example does not properly showcase how a good custom renderer should look like. A label (for example Rating) is missing. Also the cursor on the star renderer looks weird.

Also see eclipsesource/jsonforms#853 and eclipsesource/jsonforms#854

Dominant language
HTML
Stars
6
Forks
26
PR merge metrics
No merged PRs in 30d

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.

More from eclipsesource/jsonforms2-website

All issues in eclipsesource/jsonforms2-website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.