Order of contents in User Manual

Suggestions for new Logtalk features

Moderator: Paulo Moura

Post Reply
dram
Posts: 13
Joined: Thu Feb 16, 2017 9:28 am

Order of contents in User Manual

Post by dram » Fri Feb 17, 2017 1:30 am

Hi all,

I'm a newbie to Logtalk, when first looking into Logtalk, I really appreciate the richness of Logtalk's documents, thanks for your hard work!

Here is a simple suggestion, related to contents order of User Manual. I kind of think that it would be better to move "Installing Logtalk" and "Writing, Running, and Debugging Logtalk Applications" up to the top of the manual. As a first time user, the things to do is usually installing Logtalk and running some "hello world" examples.

Following are documents of some other languages which have similar order as suggested:

- Python: https://docs.python.org/3/tutorial/
- MIT Scheme: https://www.gnu.org/software/mit-scheme ... heme-user/
- Rust: https://doc.rust-lang.org/stable/book/

Paulo Moura
Logtalk developer
Posts: 472
Joined: Sat May 05, 2007 8:35 am
Location: Portugal
Contact:

Re: Order of contents in User Manual

Post by Paulo Moura » Sat Feb 18, 2017 12:40 pm

Welcome. The manuals indeed need a big overhaul. Most of the text was written 18 years ago. Improving them is on the TODO list but not the top priority currently I'm afraid. For new users, I strongly recommend that you start here:

https://learnxinyminutes.com/docs/logtalk/

After, I suggest you start playing, running, modifying the programming examples in the distribution. Use the examples NOTES.md file to guide you accordingly to your interests:

https://github.com/LogtalkDotOrg/logtal ... s/NOTES.md

Enjoy!
Paulo Moura
Logtalk developer

dram
Posts: 13
Joined: Thu Feb 16, 2017 9:28 am

Re: Order of contents in User Manual

Post by dram » Mon Feb 20, 2017 5:15 am

Thanks for your suggestions, I'll go through "Learn X in Y minutes" tutorial and examples in the distribution.

BTW, is there any TODO list or roadmap around? I have checked both at Logtalk website and github repo, but failed to find one. It will help convey the direction of Logtalk's development.

Paulo Moura
Logtalk developer
Posts: 472
Joined: Sat May 05, 2007 8:35 am
Location: Portugal
Contact:

Re: Order of contents in User Manual

Post by Paulo Moura » Mon Feb 20, 2017 3:11 pm

There isn't currently any public TODO or roadmap.
Paulo Moura
Logtalk developer

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest