No objection from me , I will make a small integration with Playground and maybe System Browser right click menu BUT I will also provide a very minimal API (request/reply) so that it can be used by anyone so its up to you guys to integrate it with your favourite tools. I will provide the database content , the database and a very small API , the rest is up to you ;) Expect a new announcement pretty soon :) On Mon, Apr 17, 2017 at 6:14 PM Offray Vladimir Luna Cárdenas < offray.luna@mutabit.com> wrote:
<Shameless self-promotion>
For interactive beginner friendly documentation, Grafoscopio is a extensively tested (in 8 Data Weeks workshops+hackathons --almost 240 hours) beginner friendly tool.
Interactive notebooks could be used with this more tooltip, chat alike tools. In fact, anything that can be put in a playground can be used in Grafoscopio. </Shameless self-promotion>
Cheers,
Offray
On 17/04/17 09:12, Dimitris Chloupis wrote:
The help browse is more for a detailed documentation , my goal is more concise and tooltip based. But yes it could be embeded in the Help browser too.
I think that interactive documentation is more beginner friendly, where documentation is everywhere you go and you do not have to open a special tool to get it.
On Mon, Apr 17, 2017 at 4:36 PM Juraj Kubelka <juraj.kubelka@icloud.com> wrote:
Great! I still believe that having the extract in the Help Browser is a good idea, at least for novices.
Juraj
On Apr 15, 2017, at 19:32, Dimitris Chloupis <kilon.alios@gmail.com> wrote:
I plan to embed it inside the playground and create a small Pharo API for it. If I can I will provide access for it from the right click menu , like do it and print it . It will take sometime but it's coming inside Pharo. On Sat, 15 Apr 2017 at 20:43, Juraj Kubelka <juraj.kubelka@icloud.com> wrote:
Nice!
Could you provide the database content using JSON REST API? We could then have this as a part of Help Browser.
Cheers, Juraj
-- Juraj Kubelka
El 14-04-2017, a las 09:30, Dimitris Chloupis <kilon.alios@gmail.com> escribió:
Part of my Discord bot as a goal was to add the ability to create database entries so that people can quickly find documentation.
It was quite a challenge for me because I had to learn how heroku works, PostgreSQL and all the other things but I did it!!!
In any discord channel you have now 3 commands !doc , !docadd , !docremove
1) !doc <search_term> search for a term in the documentation database eg. !doc pharo
2) !docadd <search_term> <content> <tags> <links> add a new entry to the documentation database eg. !docadd "pharo" "Pharo is a modern implementation of Smalltalk" "{'smalltalk','live coding','language'}" "{'squeak','IDE'}"
3)!docremove <search_term> remove a term from database eg. !docremove pharo
tags , is for more complex searches in the future, links for sending users to relevant documentation
I am also planning to give access to pharo users to the database from inside the pharo image, if its easy enough to use PostgreSQL from inside Pharo. Currently the bot is fully coded in python.
The goal is not to create a full documentation but rather quick help tips for fast pointing to the right direction.
This is also an invite to experience pharo devs and newcomers to start adding to this database.
The database is PostgreSQL , one of the most populars, I have nothing against MongoDB , its just that it works better with heroku where I host the database. But if in the future find a way to do it for free I can move to MongoDB, but no promises.
Anyway this was an excuse for me to learn database programming that I had abandoned 25 years ago (DBASE).
So have fun with this :)