Volunteer github guru for documentation submissions?
monte at appisle.net
Wed Apr 6 08:45:49 CEST 2016
> On 6 Apr 2016, at 4:38 PM, J. Landman Gay <jacque at hyperactivesw.com> wrote:
> On 4/5/2016 10:26 AM, Mark Wieder wrote:
>> But I do want to say that there's fascinating reading in
> It's only fascinating if you understand all the jargon. I read it and came away with nothing but frustration. I have only the vaguest idea what half those terms mean and the screen shots are confusing.
> Where's this "guide" they talk about? And there's some kind of viewer? Where? Where are Ali's instructions for using the web interface? It took me forever just to find where the actual documentation files live. (Why are the doc files in the *engine* category? Wouldn't one logically look in the IDE category?)
> Pointers to instructions should be located prominently somewhere, ideally on the entry page. Github is a maze at best, novices shouldn't have to hunt for elusive instructions. I'm pretty sure someone here will give me a link, but that isn't going to help the next person.
I hadn’t seen the contributing to the docs guide so even though I know my way around GitHub it was fresh eyes on finding the docs. Here’s what I did:
- open https://github.com/livecode/livecode/
- see the “Contributing to LiveCode” section links to the CONTRIBUTING file https://github.com/livecode/livecode/blob/develop/CONTRIBUTING.md
- Right at the top there is "See also the documentation contributions guide.” linked to https://github.com/livecode/livecode/blob/develop/docs/contributing_to_docs.md
- Scroll down to find the “Using the GitHub Web Interface” section
More information about the use-livecode