andre at andregarzia.com
Tue Aug 1 18:48:55 EDT 2017
Yes, I can give more details, I am not talking about library documentation
as it is generated by lcdoc but the overall state of the documentation. The
main issue for me is a UX one. The built-in LC dictionary UI is not good.
For example, on my Surface 4 Pro, I can't change the little dropdown to
select the httpd API as the popup list is larger than my screen and does
not scroll with the trackpad. That is just an example, a simple list of
opportunities for enhancement would be:
* Provide sample stacks for all LC dictionary entries (multiple entries can
share the same sample but no entry can be without at least one sample). The
sample stacks need to be something that the person can click and run.
* A better wiki or comment system.
* Libraries need to be more discoverable.
Right now we have documentation spread all over the place. There are things
in release notes, things in emails, stuff in the dictionary, stuff only on
the website, and finding things is quite hard. The navigation is
challenging, for example, searching httpd on the website yields nothing. I
had to go to github and look for the source.
On Tue, Aug 1, 2017 at 5:18 PM, Monte Goulding via use-livecode <
use-livecode at lists.runrev.com> wrote:
> > On 2 Aug 2017, at 4:02 am, Andre Garzia via use-livecode <
> use-livecode at lists.runrev.com> wrote:
> > I wish there was a more comprehensive documentation effort going on.
> Hi Andre
> Can you give a little more detail on your complaint here. All our new
> libraries are documented with lcdoc block comments which are extracted
> during the build and appear in the documentation. At the moment you need to
> choose the extension you are interested in as they don’t appear in the
> LiveCode Script api but in the future we will change this so all things
> available from LiveCode script are in the LiveCode Script API section.
> use-livecode mailing list
> use-livecode at lists.runrev.com
> Please visit this url to subscribe, unsubscribe and manage your
> subscription preferences:
http://www.andregarzia.com -- All We Do Is Code.
http://fon.nu -- minimalist url shortening service.
More information about the Use-livecode