KhronosGroup / KhronosGroup/glTF-Project-Explorer

Clarify "task" and consider something like "keywords"

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
95
Forks
48
PR merge metrics
No merged PRs in 30d

Description

The task field of the entries currently has this description:

An array of strings, describing the basic tasks that are supported by the project.

Common examples of tasks are view, load, import, export, validate, or optimize.

This is somewhat rooted in the original structure of the projects list in the glTF README, where the projects had been in sections like "Viewers", "Importers", "Loaders", "Exporters" etc.

In general, it is sometimes hard to figure out a sensible value for this field. We might have to add some clarification here: Most of the current entries try to use one of the examples mentioned above, and I think that this makes sense to some extent. People can easily search for "view" when they just want a viewer.

We could, however, consider to either allow/foster more differentiation here, or add something like a "tags" or "keywords" field, which could basically be free-text, and be taken into account when typing something into the main search field. The description could then be:

Keywords that cause the project to be found during a search operation.

And yes, we will have to prevent people from adding a 10-million-entry list like "a", "aa", "ab", ... "zzz"... at some point - the keywords should be "reasonable"....)

Are there any thoughts or ideas on that?

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 by reviewing the current task field description and how the main search field uses entry data. Determine whether the issue should clarify task values, add a free-text tags or keywords field, or change search behavior; done requires a decided scope and agreed rules for reasonable keywords.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.