mapbox / mapbox/simplestyle-spec

Mention what formats Description can be in

Open
#29 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
296
Forks
116
PR merge metrics
No merged PRs in 30d

Description

```
// OPTIONAL: default ""
// A description to show when this item is clicked or
// hovered over
"description": "A description",
```
Mention if this can only be plain text or 'rich text' or HTML etc. or mention if it is explicitly not the role of the definition to define this.

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

Start with the specification entry containing the `description` example in this issue and review nearby field definitions for formatting guidance. Document whether Description accepts plain text, rich text, or HTML, or state that format is outside the definition's scope; it is done when the specification answers this explicitly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.