[Sugar-devel] Introduction and review request of GSoC Proposal:

James Cameron quozl at laptop.org
Wed Mar 14 03:04:02 EDT 2018


G'day Rudra,

Thanks for being at the meeting earlier, and for your proposal.

A project for GSoC 2013 added context sensitive help, or user
documentation, to the Sugar desktop, with alt+shift+h key.

It works with the Help activity.  Metadata in the Help activity links a
subject activity to a markdown source file, which is converted to HTML
and rendered in a tiny browser.

Many of these source files came from the Wiki pages of activities, and
have been updated since then.

Please review and integrate the Help activity into your proposal; for
instance;

- avoid duplicating user documentation into activity repositories,
  because that would make for unncessary maintenance burden, or;

- move some of the Help activity files into activity repositories and
  provide a way to update the Help activity from the subject
  activities.

Please review the discussion on these two pull requests;

https://github.com/sugarlabs/activity-abacus/pull/12
https://github.com/sugarlabs/sugar-docs/pull/137

And then ask any questions to clarify, thanks.

-- 
James Cameron
http://quozl.netrek.org/


More information about the Sugar-devel mailing list