aframevr / aframevr/aframe

[feature request] Schema - add "displayname" and "description" fields

Open
#5,338 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
17.6k
Forks
4.4k
PR merge metrics
No merged PRs in 30d

Description

The Aframe-Inspector and possible other editors use component schema to build editor UI. It will be useful to add human readable displayname and description fields to schema so editor can create human friendly interface. This especially useful for things like material parameters which need some usage tips.

Contributor guide

Open the contributing guide

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

The issue concerns component schemas consumed by the A-Frame Inspector and other editors, especially material parameters; no implementation files or tests are named. Trace the schema entry points and existing editor-facing consumers first, then define what the two human-readable fields must mean and verify that schema consumers can use them without breaking existing schemas.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.