Pharo Docs website broken
Locked
12
12
 
|
I never used Pharodoc, I don’t really see the point. And apparently I am not alone. So, I have a provocative question: why don’t you just remove it?
It is broken now and it will take energy to fix, and this energy can be much better spent elsewhere. Plus it will take maintenance time and energy at some point in the future, it is probable that it will break again at some point, since the www behaves like this. Just get rid of this burden.
---> Save our in-boxes! http://emailcharter.org <---
Johan Fabry - http://pleiad.cl/~jfabry PLEIAD and RyCh labs - Computer Science Department (DCC) - University of Chile |
|
|
In reply to this post by kilon.alios
main purposes of pharodocs were:
1) make pharo code to appear in the indexes 2) make newcomers (who are used to javadocs and lots of stuff we do not need) feel more confortable, until they realise is actually not needed :P Esteban
|
Re: Pharo Docs website broken
|
|
In reply to this post by jfabry
The point is visibility towards web users and robots.
It also contains quite a bit of technology, it would be a shame to lose it. But yes, of course, real Pharo programmers will never use it, in-image browsing is so much better. Maybe a more down to earth, simpler version would be better. > On 11 Jan 2016, at 14:37, Johan Fabry <[hidden email]> wrote: > > I never used Pharodoc, I don’t really see the point. And apparently I am not alone. So, I have a provocative question: why don’t you just remove it? > > It is broken now and it will take energy to fix, and this energy can be much better spent elsewhere. Plus it will take maintenance time and energy at some point in the future, it is probable that it will break again at some point, since the www behaves like this. Just get rid of this burden. > >> On Jan 11, 2016, at 10:28, Dimitris Chloupis <[hidden email]> wrote: >> >> yeah i can confirm that as well, but i never tried to resize the panels before, but frankly its not a huge deal, phardoc does not offer anything more than what the pharo image already offers and is many times less flexible. I used only once when i was on vacations and wanted to take a look at a couple of things. >> >> On Mon, Jan 11, 2016 at 3:19 PM David Allouche <[hidden email]> wrote: >> Yes, that's what I talked about in the first place. >> >> Here's the screenshot I should have included at first. See, no method names. >> >> <PastedGraphic-1.png> >> >> >> Also, if one tries resizing the panes, things start breaking in visually interesting ways… >> >> >> <PastedGraphic-2.png> >> > > > ---> Save our in-boxes! http://emailcharter.org <--- > > Johan Fabry - http://pleiad.cl/~jfabry > PLEIAD and RyCh labs - Computer Science Department (DCC) - University of Chile > |
|
|
In reply to this post by jfabry
well… maintenance is (usually) just run the generation process.
Some months ago Guille made a simplified version and I was thinking on just load it and execute it… they go to sleep :) the reasons for pharodocs to be there are not so important and nothing will change a lot if removed. But I would keep it anyway, if possible. Esteban
|
|
I was wondering if github interface could help here to make it much more powerful On Mon, Jan 11, 2016 at 3:43 PM Esteban Lorenzano <[hidden email]> wrote:
|
|
|
In reply to this post by EstebanLM
BUT: please keep in mind that having bad documentation is actually worse than not having any documentation at all. So ideally you would regenerate the site tonight before you go to sleep. :-)
---> Save our in-boxes! http://emailcharter.org <---
Johan Fabry - http://pleiad.cl/~jfabry PLEIAD and RyCh labs - Computer Science Department (DCC) - University of Chile |
|
|
Personally I would prefer if Esteban kept working on documenting the new FFI. Thats a top priority doc wise, the rest can wait. Στις Δευ, 11 Ιαν 2016 - 15:57 ο χρήστης Johan Fabry <[hidden email]> έγραψε:
|
|
|
In reply to this post by Tudor Girba-2
We should keep PBE and add another link.
Stef Le 11/1/16 10:45, Tudor Girba a écrit : > I think that UPBE is in definitely a better state than PBE. We should switch the link. > > @Dimitris: Could you open an issue for this? > > Doru > > >> On Jan 11, 2016, at 11:37 AM, Sven Van Caekenberghe <[hidden email]> wrote: >> >> >>> On 11 Jan 2016, at 10:24, Dimitris Chloupis <[hidden email]> wrote: >>> >>> I agree with you only 100% + 1. >>> >>> Also note that UPBE is not promoted even though its the most begineer friendly documentation we have, instead you have to navigate through the links to get there. >> There is books.pharo.org >> >> PBE is there, I thought UPBE was not yet ready, if it is, it should **definitively** be promoted there and on pharo.org in general. >> >> Please push this, this is really important. >> >>> AFAIK the documentation page could use some love, promoting our main Book, UPBE, Pharo for the Enterprise , Deep Into Pharo. Those 3 are essential reading for anyone coming to pharo and they are in a pretty good state , though WIP. >>> >>> I have to say that I never liked Pharo docs because it shows how few classes contain comments and it definitely does not look good for someone looking to enter pharo. >>> >>> On Mon, Jan 11, 2016 at 1:48 AM David Allouche <[hidden email]> wrote: >>> I could argue about how I agree with you, but only in part. >>> >>> But the simple fact is this: the documentation is advertised in large letter on this page: http://pharo.org/documentation >>> >>> If it's broken, it should be fixed. If the people with the technical access to fix it do not care, it should be removed from such a highly visible page. >>> >>> As it is, it is confusing for new users, who need it most, and reflects badly on the state of Pharo in general. >>> >>>> On 10 Jan 2016, at 22:25, Serge Stinckwich <[hidden email]> wrote: >>>> >>>> Dear David, >>>> >>>> yes this maybe broken, but most of the time, a Pharo developer will >>>> never have a look to such a static documentation. >>>> You can browse the class and the related methods very easily inside >>>> the Pharo image, without relying on an external tool. >>>> >>>> Regards, >>>> >>>> On Sun, Jan 10, 2016 at 1:08 PM, David Allouche <[hidden email]> wrote: >>>>> Hello, >>>>> >>>>> It seems the pharodocs website is broken. Pages for classes are rendered, >>>>> but the documentation does not display the messages, only their docstrings. >>>>> That makes it quite unusable. >>>>> >>>>> http://files.pharo.org/doc/4.0/#packageList=package.html&classList=package/Kernel.html&classView=class/ProtoObject.html >>>>> >>>>> I remember I looked at it once when I started and thought "whee, that's >>>>> confusing, I'll play around and come back later". Now I understand why that >>>>> was confusing... >>>>> >>>>> Who can fix that? >>>> >>>> >>>> -- >>>> Serge Stinckwich >>>> UCBN & UMI UMMISCO 209 (IRD/UPMC) >>>> Every DSL ends up being Smalltalk >>>> http://www.doesnotunderstand.org/ >>>> >>> >> > -- > www.tudorgirba.com > www.feenk.com > > "To utilize feedback, you first have to acquire it." > > > |
«
Return to Pharo Smalltalk Users
|
1 view|%1 views
| Free forum by Nabble | Edit this page |