Ok, now I know what I want. I want a better way to document. Because I’m trying to write a documentation about my stuff, but there are too many disconnected ways to do that. I’m trying to always have reasonable class comments. But sometimes you need a more general description, so you write help topics which are disconnected from class comments. Yes, we can add help topics generated from class comments but that’s too weak. Additionally I version my projects on github, so I want t doc there in readme, or on a wiki. What’s more I think that it’s a good idea to export doc to the web. Because when someone mentioned package manifest I started to google for it and could not find anything.
My suggestions: - write comments in pillar and slowly add pillar support to enrich comment (documentation) styles - add a possibility to reference classes/methods and help topics from pillar comments - have exporters to generate html documentation about a project based on comments and help topics - then I will be able to add a hook to Icebeg telling it: ok, on commit also generate a doc and export it as MarkDown (because we can) and commit it as a README or as a wiki entry or whatever. This way we will have interconnected documentation in the image, and if it should be placed somewhere else we export it. Cheers. Uko > On 24 Aug 2016, at 06:59, stepharo <[email protected]> wrote: > > Hi > > We have some ideas (because people are working on items) for the Pharo 6 > roadmap > > and we will consolidate them soon and propose them to you. > > but I would like to know two kinds of points > > - what are the points you are working on and that would deserve more focus > and help from the community? > > (these points are important because like that you could go faster and > this is a good feeling to get done for example) > > - what would be points where (if magically we would get more resources - > to not dream if this is not you > > there is a high chance that we will not make it) it would be nice to > get some changes > > > Please pay attention that if you type too fast and come up with a christmas > list well it will stay a christmas list and will just make the thread larger > for nothing. > > Stef > >
