Metadata: Use 'environment' property

Open
#241 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Open the linked screenshots section in the app-development documentation and review the existing screenshot tag examples. Document the environment property with pantheon and pantheon:dark values, then verify the rendered page and links.

Written by the indexing model from the issue text.

Description

Priority: Wishlist
Problem

AppCenter (the desktop app) supports filtering screenshot using environment property of screenshot tag, but the documentation does not use it, resulting the developers may not notice this great feature.

https://docs.elementary.io/develop/writing-apps/our-first-app/metadata#screenshots

Proposal

Write about use of environment property.

  • Use pantheon for light style and pantheon:dark for dark style as its value
Prior Art (Optional)

FYI: https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-screenshots:~:text=present%2E-,Optionally

Dominant language
No language data
Stars
88
Forks
30
Avg merge
3h 28m
Merged PRs (30d)
1

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.

More from elementary/docs

All issues in elementary/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.