Help create documentation for gnome-sudoku
completed by: Chris Beiser
mentors: Tiffany Antopolski
- Create topic-based help for users of gnome-sudoku (part of gnome-games) (see bug 618342).
- Review existing topic drafts for usefulness and accuracy (printing, hints, trackers, statistics, bug reporting)
- Propose topics that you may think would be useful to users
- Fill in stub pages with user help, and/or write your own from scratch. Existing stubs that need content include introduction, basics, game rules, save-resume, highlighting, notes, toolbar, commandline, and keyboard shortcuts.
- Expected results: 3-5 or more topics fully documented (and attached to the bug in the form of a git format-patch). Existing topics reviewed and other topics proposed, if need be.
- Requirements: install gnome-games, understand gnome-sudoku, a good-command of English and ability to write and explain concepts clearly. An understanding of Mallard, gnome bugzilla and Git is a great asset.
- Steps:
- Get the current version of the docs from git.gnome.org by typing in terminal:
git clone git://git.gnome.org/gnome-games
- then type:
cd gnome-games/gnome-sudoku/help/C
- and then type
yelp index.page
- This enables you to view the current state of the docs using Yelp.
- Get the current version of the docs from git.gnome.org by typing in terminal:
- Note: The games Mahjongg (see bug 618344) and gnomine are also candidates for Mallard documentation. At the moment, no outline or stubs or anything exists in the Mallard format for these games. If you would like to contribute to these documentation efforts, it would involve writing the docs from scratch. You would learn tonnes! Feel free to contact me and we could discuss it.