Application Help Tasks

This page is designed so you can:

  • find a GNOME application that you want to document
  • see the status of the project documentation
  • get the project source files
  • review the project's documentation bugs
  • contact the project's documentation maintainer

If you're interested in contributing to an application's documentation, contact the documentation maintainer for that project, or send a note to the GNOME documentation mailing list.

Useful References

Reference

Docs status color indicators

This page uses different colors to give a general indication of the documentation status:

Up-to-date:

Marked with [OK] and the version number. Used when the docs are maintained and are in good shape.

Need to be refreshed:

Marked with [REFRESH] and the version number from when the docs were current. Used when the docs may be a bit outdated and need to be reviewed and refreshed.

Needs work:

Marked with [NEEDSWORK] and the version number from when the docs were current (if known). Used when docs are significantly outdated.

Viewing documentation

To view a project's current documentation, clone the project's software repository using the git command listed for each project, then enter the following into a terminal window:

yelp [project name]/help/C/

This will render the project documentation in yelp, the GNOME help browser.

Core

These projects are the priority for the Documentation Team.

Boxes

Docs status:

[NEEDSWORK] GNOME 3.16

Notes:

https://wiki.gnome.org/Apps/Boxes/Documentation/MallardBrainstorming

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-boxes.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-boxes/issues?label_name[]=8.+User+Docs

Contact:

Mike Hill

Calculator

Docs status:

[OK] GNOME

Notes:

Some Gcalctool documentation bugs need fixing.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gcalctool.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-calculator/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

Contacts

Docs status:

[REVIEW] GNOME 3.16

Notes:

UI is in a state of flux; needs complete review

Project Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-contacts.git

Help Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-user-docs.git

Documentation Bugs:

In gnome-user-docs

Document Viewer (evince)

Docs status:

[REFRESH] GNOME 3.28

Notes:

Adjust to header bar menu changes, button names etc

Git repository:

git clone https://gitlab.gnome.org/GNOME/evince.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/evince/issues?label_name[]=8.+User+Docs

Contact:

Text Editor (gedit)

Docs status:

[REFRESH] GNOME 3.34

Notes:

Needs some minor tweaks on some pages, see open tickets in Gitlab

Git repository:

git clone https://gitlab.gnome.org/GNOME/gedit.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gedit/issues?label_name[]=8.+User+Docs

Contact:

Jim Campbell - Jim has started work on updates for 3.12

GNOME Terminal

Docs status:

[OK] GNOME 3.34

Notes:

Terminal docs are up-to-date for 3.35 except for one minor issue

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-terminal.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-terminal/issues?label_name[]=8.+User+Docs

Contact:

Web (epiphany)

Docs status:

[REVIEW] GNOME 3.16

Notes:

Idea for improvement, section "Improve my privacy" (Activate Don't track, Privilege use of HTTPS protocol, Untick "Allow Advertisement", Use duckduckgo to perform web search), Commons problems: page crashing, document Often-used websites from Homepage.

Git repository:

git clone https://gitlab.gnome.org/GNOME/epiphany.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/epiphany/issues?label_name[]=8.+User+Docs

Contact:

Kat

Games

2048

Docs status:

[NEEDSWORK] GNOME 3.34

Notes:

Apart from one sentence, it is completely empty.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-2048.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-2048/issues?label_name[]=8.+User+Docs

Contact:

Aisleriot

Docs status:

[NEEDSWORK] GNOME 3.16

Notes:

Conversion to Mallard not started. Problem with licensing: compromise with maintainer is CC-by-SA + GPL3 dual license, see terminal help for more info (not compatible with our other projects). Consider bug 338122 and bug 444411 and these bugs too

Git repository

git clone https://gitlab.gnome.org/GNOME/aisleriot.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/aisleriot/issues?label_name[]=8.+User+Docs

Contact:

five-or-more

Docs status:

[OK] GNOME 3.32

Notes:

Topics don't have descriptions

Git repository

git clone https://gitlab.gnome.org/GNOME/five-or-more.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/five-or-more/issues?label_name[]=8.+User+Docs

Contact:

four-in-a-row

Docs status:

[OK] GNOME 3.36

Notes:

Updated for 3.35.91

Git repository

git clone https://gitlab.gnome.org/GNOME/four-in-a-row.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/four-in-a-row/issues?label_name[]=8.+User+Docs

Contact:

gnome-chess

Docs status:

[OK] GNOME 3.32

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-chess.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-chess/issues?label_name[]=8.+User+Docs

Contact:

gnome-klotski

Docs status:

[OK] GNOME 3.34

Notes:

Docbook documentation is up-to-date for 3.34.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-klotski.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-klotski/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

gnome-mahjongg

Docs status:

[OK] GNOME 3.34

Notes:

Up-to-date in 3.34

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-mahjongg.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-mahjongg/issues?label_name[]=8.+User+Docs

Contact:

Chris Beiser

gnome-mines

Docs status:

[OK] GNOME 3.34

Notes:

Topics don't have descriptions, need to cover themes

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-mines.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-mines/issues?label_name[]=8.+User+Docs

Contact:

Sophia Yu

gnome-nibbles

Docs status:

[NEEDSWORK] GNOME 3.36

Notes:

Documentation was correct for 3.34; needs work for 3.37 though.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-nibbles.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-nibbles/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

gnome-robots

Docs status:

[OK] GNOME 3.34

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-robots.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-robots/issues?label_name[]=8.+User+Docs

Contact:

gnome-sudoku

Docs status:

[OK] GNOME 3.34

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-sudoku.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-sudoku/issues?label_name[]=8.+User+Docs

Contact:

gnome-tetravex

Docs status:

[OK] GNOME 3.34

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-tetravex.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-tetravex/issues?label_name[]=8.+User+Docs

Contact:

iagno

Docs status:

[OK] GNOME 3.34

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/iagno.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-iagno/issues?label_name[]=8.+User+Docs

Contact:

Brian Grohe

lightsoff

Docs status:

[OK] GNOME 3.34

Notes:

Correct as of 3.34

Git repository

git clone https://gitlab.gnome.org/GNOME/lightsoff.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/lightsoff/issues?label_name[]=8.+User+Docs

Contact:

Perumal Viravan

quadrapassel

Docs status:

[OK] GNOME 3.34

Notes:

Up-to-date in 3.34, but reconsider the full-color house icons and the home links.

Git repository

git clone https://gitlab.gnome.org/GNOME/quadrapassel.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/quadrapassel/issues?label_name[]=8.+User+Docs

Contact:

swell-foop

Docs status:

[NEEDSWORK] GNOME

Notes:

Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten.

Git repository

git clone https://gitlab.gnome.org/GNOME/swell-foop.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/swell-foop/issues?label_name[]=8.+User+Docs

Contact:

tali

Docs status:

[NEEDSWORK] GNOME

Notes:

Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten.

Git repository

git clone https://gitlab.gnome.org/GNOME/tali.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-tali/issues?label_name[]=8.+User+Docs

Contact:

Other applications/projects

Files, folders and documents

Documents

Docs status:

[OK] GNOME

Notes:

TODO: new pages (password protection and sharing through Google Docs)

Project Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-documents.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-documents/issues?label_name[]=8.+User+Docs

Contact:

File Roller Archive Manager

Docs status:

[OK] GNOME 3.34

Notes:

Docs are up-to-date for 3.34; someone could check (or remove?) the keyboard shorcuts page though

Git repository:

git clone https://gitlab.gnome.org/GNOME/file-roller.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/file-roller/issues?label_name[]=8.+User+Docs

Contact:

Document Scanner (Simple Scan)

Docs status:

[REFRESH] GNOME 3.16

Notes:

Got updated for 3.35 etc; someone still needs to check external.page and quality.page which don't have a "revision" header

Git repository:

git clone https://gitlab.gnome.org/GNOME/simple-scan.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/simple-scan/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

Networking and web applications

Polari IRC client

Docs status:

[NEEDSWORK] GNOME

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/polari.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/polari/issues?label_name[]=8.+User+Docs

Contact:

Vinagre Remote Desktop Viewer

Docs status:

[REVIEW] GNOME 3.16

Notes:

Complete. No plants to change UI in the near future.

Git repository:

git clone https://gitlab.gnome.org/GNOME/vinagre.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/vinagre/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Multimedia applications

Brasero Disc Burner

Docs status:

[OK] GNOME

Notes:

Complete, check if it needs a review. Note that Brasero is unmaintained as of 2019.

Git repository:

git clone https://gitlab.gnome.org/GNOME/brasero.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/brasero/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Cheese Photo Booth Application

Docs status:

[OK] GNOME 3.34

Notes:

Up-to-date in 3.34

Git repository:

git clone https://gitlab.gnome.org/GNOME/cheese.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/cheese/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Eye of GNOME (eog)

Docs status:

[OK] GNOME 3.30

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/eog.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/eog/issues?label_name[]=8.+User+Docs

Contact:

Music

Docs status:

[NEEDSWORK]

Notes:

UI changes planned for 3.12, wait until these are done

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-music.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-music/issues?label_name[]=8.+User+Docs

Contact:

Photos

Docs status:

[NEEDSWORK]

Notes:

Sort of done. Needs some editing. Will be up on a branch soon.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-photos.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-photos/issues?label_name[]=8.+User+Docs

Contact:

Pitivi video editor

Docs status:

[REFRESH]

Notes:

Good coverage, but can always be extended, refined or translated. Needs to be updated for major changes for the next release.

Git repository:

git clone https://gitlab.gnome.org/GNOME/pitivi.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/pitivi/issues?label_name[]=8.+User+Docs

Contact:

Jeff Fortin

Rhythmbox Media Player

Docs status:

[OK] GNOME 3.34

Notes:

Updated for 3.4.4 release in January 2020.

Git repository:

git clone https://gitlab.gnome.org/GNOME/rhythmbox.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/rhythmbox/issues?label_name%5B%5D=8.+User+Docs

Contact:

Jim Campbell

Shotwell Photo Manager

Docs status:

[OK] GNOME

Notes:

Docs are complete and are maintained by the Shotwell developers

Git repository:

git clone https://gitlab.gnome.org/GNOME/shotwell.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/shotwell/issues?label_name[]=8.+User+Docs

Contact:

Shotwell developers

Totem Movie Player

Docs status:

[OK] GNOME 3.32

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/totem.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/totem/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Other Utilities

Clocks

Docs status:

[NEEDSWORK]

Notes:

[https://belmoussaoui.com/2020/02/23/tick-tock-clocks-got-redesigned/ Got completely redesigned in 3.35]

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-clocks.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-clocks/issues?label_name[]=8.+User+Docs

Contact:

Accerciser

Docs status:

[REFRESH]

Notes:

Screenshots are up-to-date for 3.34

Git repository:

git clone https://gitlab.gnome.org/GNOME/accerciser.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/accerciser/issues?label_name[]=8.+User+Docs

Contact:

GNOME Notes

Docs status:

[NEEDSWORK] GNOME 3.15

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-notes.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-notes/issues?label_name%5b%5d=8.+User+Docs

Contact:

Dictionary

Docs status:

[NEEDSWORK] 3.26

Notes:

No sense to work on this until https://gitlab.gnome.org/GNOME/gnome-dictionary/issues/9 is solved. UI has radically changed; needs pages on "Strategies" and installing a offline DICT server.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-dictionary.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-dictionary/issues?label_name[]=8.+User+Docs

Contact:

Disk Usage Analyzer (baobab)

Docs status:

[OK]

Notes:

All bugs closed start of 3.15 cycle. Possibly add screenshot to intro.

Git repository:

git clone https://gitlab.gnome.org/GNOME/baobab.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/baobab/issues?label_name[]=8.+User+Docs

Contact:

Evolution

Docs status:

[OK] GNOME 3.34

Notes:

Up-to-date for for 3.34; smaller Evolution documentation bugs welcome fixing.

Git repository:

git clone https://gitlab.gnome.org/GNOME/evolution.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/evolution/issues?label_name[]=8.+User+Docs

Contact:

Andre Klapper

Characters

Docs status:

[NEEDSWORK]

Notes:

Help does not exist as of 3.34

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-characters.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-characters/issues?label_name[]=8.+User+Docs

Contact:

Passwords and Keyrings (seahorse)

Docs status:

[NEEDSWORK] GNOME 3.14

Notes:

Needs review and lots of checks; UI completely changed in 3.34

Git repository:

git clone https://gitlab.gnome.org/GNOME/seahorse.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/seahorse/issues?label_name[]=8.+User+Docs

Contact:

Jim Campbell

Maps

Docs status:

[OK] GNOME

Notes:

There simply is no documentation.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-maps.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-maps/issues?label_name[]=8.+User+Docs

Contact:

GNOME System Monitor

Docs status:

[REVIEW] GNOME 3.16

Notes:

Index needs reordering, pages with a "review" status need reviewing. Needs to be made nice for the website. Don't use Latin.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-system-monitor.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-system-monitor/issues?label_name[]=8.+User+Docs

Contact:

Mike Hill

Vino Desktop Sharing

Docs status:

[REVIEW] GNOME 3.16

Notes:

Vino has not seen a release since 2016 and the last code related changes were in September 2018. It might be less maintained or unmaintained.

Git repository:

git clone https://gitlab.gnome.org/GNOME/vino.git

Documentation Bugs:

In gnome-user-docs.

Contact:

Ekaterina Gerasimova

Zenity

Docs status:

[OK] GNOME 3.36

Notes:

Updated (incl English screenshots) for 3.35

Git repository:

git clone https://gitlab.gnome.org/GNOME/zenity.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/zenity/issues?label_name[]=8.+User+Docs

Contact:

gdm

Docs status:

[NEEDSWORK] GNOME 2.28

Notes:

Absolutely outdated, and probably needs an extremely tech-savvy person to understand and update

Git repository:

git clone https://gitlab.gnome.org/GNOME/gdm.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gdm/issues?label_name[]=8.+User+Docs

Contact:

ghex

Docs status:

[OK] GNOME 3.34

Notes:

ghex 3.18.4 user docs seems pretty correct; might only needs minor updates/tweaks

Git repository

git clone https://gitlab.gnome.org/GNOME/ghex.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/ghex/issues?label_name[]=8.+User+Docs

Contact:

Recipes

Docs status:

[OK] GNOME

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/recipes.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/recipes/issues?label_name[]=8.+User+Docs

Contact:

Paul Cutler

gedit-plugins

Docs status:

[OK] GNOME 3.34

Notes:

Updated for 3.34

Git repository

git clone https://gitlab.gnome.org/GNOME/gedit-plugins.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gedit-plugins/issues?label_name[]=8.+User+Docs

Contact:

CategoryDocumentationProject

DocumentationProject/Tasks/ApplicationHelp (last edited 2020-07-09 12:04:56 by AndreKlapper)