|
|
Hi guys - I've decided to try and use moments of spare time to see if I can contribute in small ways (and I'm sorry I can't contribute in big ways - but maybe I will get up to that point).
Anyway - I've thought it would be handy to improve the help text in Pharo - as this it where I first looked to find out a few things about the new environment, and discovered that the help doesn't really provide help on the environment.
So having scouted around and looked at the help engine - it seemed like easiest way was to use the WikiHelp support, and put a pragma in a suitable place (initially I subclassed CustomHelp - but I think that is for more sophisticated uses than just documenting some basic help).
Anyway - I created a package called "Pharo-Help" - and so my first question is: Are there names I should avoid, or conventions I should follow for good package names?
I've then created a class "PharoEnvironmentHelp" with a class method #wikiStyleHelp (which is a convention I've seen in other places) - and it reads the class comment so it's easy to edit.
However - should I use a separate class for this? It does keep it out of the way - but it ends up not being a class that does anything - so I could put this text on something else that represents "Pharo" - or is this fine?
I've also given it the name "? Pharo Help" so it appears at the top of the list - my thinking being that new users would probably expect intro help at the top and the "?" does this.
Finally - how do I submit it? (and I'm happy to read up on this, if there is something that has it nicely documented).
Tim
|
Locked
