Volunteer github guru for documentation submissions?

Kay C Lan lan.kc.macmail at gmail.com
Wed Apr 13 22:37:53 EDT 2016


On Thu, Apr 14, 2016 at 8:45 AM, Monte Goulding <monte at appisle.net> wrote:

>
> There’s no productivity gains in using a LC docs specific git gui only a
> slightly reduced learning curve.


I my LC Heaven there would be both :-)

In the LC Dictionary you notice an error
There is an Edit button to click on
It retrieves the appropriate lcdoc file from the correct GitHub Branch
It opens in a separate stack - an lcdoc Editor
It opens in default WYSIWYG mode.
You type in your correction/addition.
Because LC knows ALL it's own keywords (commands, objects, etc) it can
automatically reference them
If you type in any ambiguous references it can ask which one you meant (and
markup accordingly)
You change to Check mode - where clicking around will cause the Dictionary
to open at the appropriate Entry
  - if clicking on a recently added word doesn't work or takes you to the
wrong Entry
You have Raw mode - because sometimes WYSIWYG doesn't get it right and you
just have to do the markup yourself.
Back to Check mode to confirm your Raw changes work.
If you type in an Example: - it can be colour coded - so less likely to
make a mistake
In Compile mode you can check that each Example: wont return a error, and
any result is placed in msg
You have a Submit button
It creates the GitHub PR for you.
The lcdoc Editor Stack vanishes and you continue to productively code away.

But I'm sure a reduced learning curve would be paradise for many ;-)



More information about the use-livecode mailing list