Write and bundle documentation

Bug #778981 reported by Maia Everett on 2011-05-07
This bug affects 6 people
Affects Status Importance Assigned to Milestone
Cameron White

Bug Description

Pinta should have documentation bundled with the application, detailing its various features, tools, and hotkeys.

I might take a shot at writing documentation in the Docbook format used by GNOME, which can then be either shipped as is or compiled to HTML.

Maia Everett (linneris) on 2011-05-21
description: updated
Adolfo Jayme (fitojb) on 2011-09-13
Changed in pinta:
status: New → Confirmed
grofaty (grofaty) wrote :

Just wondering is there some work done in this field? I like how documentation is done in Notepad++ (Windows open-source text editor) - from Help menu there is started local HTML file. URL of web page is in the following logic file://path_to_the_program_install_dir/documentation.html - this kind of solution is probably simple enough for multiplatform and also to have the same documentation on official project web page. I am willing to write or make a revision of documentation. But we need some simple way to exchange documentation contributions.

Jonathan Morlock is in charge of this, and I'm pitching in.

Changed in pinta:
importance: Undecided → Medium
status: Confirmed → In Progress
Alan Horkan (horkana) wrote :

is there a copy of the work in progress available somewhere?

Cameron White (cameronwhite91) wrote :

Not that I'm aware of ...

We've been talking about doing this for a while but never really got around to it, so I'll be ambitious and target this for 1.7 :)

There are a bunch of things on the technical side of things to figure out, like what format to use (Mallard, Docbook, Sphinx, etc), how to handle translations, and how it should be packaged with Pinta / made available.

Changed in pinta:
milestone: none → 1.7
status: In Progress → Confirmed
grofaty (grofaty) wrote :

Documentation can be a huge project by itself, so one of the most imporant thing in my humble opinion is collaboration method and also a documentation maintainer to coordinate what gets in and what not. One of the ways is to create similar tutorials like Terry did in youtube.com videos, see top articles: http://pinta-project.com/howto/pinta-on-web

Cameron White (cameronwhite91) wrote :
Changed in pinta:
assignee: nobody → Cameron White (cameronwhite91)
status: Confirmed → In Progress
Ken Sharp (kennybobs) on 2015-12-11
tags: added: manpage
Changed in pinta:
assignee: Cameron White (cameronwhite91) → Megan leblanc (mleblanc88)
Cameron White (cameronwhite91) wrote :

There is now a great user guide that we can provide on the website (https://github.com/PintaProject/user-guide), so for 1.7 we should remove the yelp-based documentation (which is extremely incomplete) and point to the new user guide

Changed in pinta:
assignee: Megan leblanc (mleblanc88) → Cameron White (cameronwhite91)
Cameron White (cameronwhite91) wrote :
Changed in pinta:
status: In Progress → Fix Committed
grofaty (grofaty) on 2020-08-05
Changed in pinta:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers