<div id="__MailbirdStyleContent" style="font-size: 10pt;font-family: Arial;color: #000000;text-align: left" dir="ltr">
<div><span style="font-size: 13.3333px">Hi all --</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">I am not quite sure, what the overall goal is here. :-) "HelpBrowser+Seaside" sounds like a regular, web-based wiki, which be already have: wiki.squeak.org.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">Squeak's help browser is in a pretty good shape to author, version, and share content for Squeak Trunk. The only downside is Monticello's full-method merge algorithm, making it hard to jointly improve a piece of writing. Yet, one does not have to store help content in methods. Files work, too. And so do pages via wiki.squeak.org.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">If there are not that many authors for a piece of writing, I would suggest using the status quo -- favoring Help Browser (via methods) over Class Comments.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">If there are several authors, just create a page on wiki.squeak.org and start writing. Then create a new entry for Squeak's Help Browser, specifically fetching that wiki page in a new help book/page. While this would likely be read-only from within the image, people could edit that through the Web front-end easily.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">This would also work with any other wiki. Squeak's Help Browser could easily be used as a "reader" for such important wiki pages. And a common entry point to look for important information from within the image.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">***</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">The help content should be as close as can be to the artifacts it is going to provide help for.</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">Best,</span></div><div><span style="font-size: 13.3333px">Marcel</span></div><div><span style="font-size: 13.3333px"><br></span></div><div><span style="font-size: 13.3333px">P.S.: We could easily extend the MCMcmUpdater to give a special notification for new help content. :-)</span></div><div><br></div><div class="mb_sig"></div>
<blockquote class="history_container" type="cite" style="border-left-style: solid;border-width: 1px;margin-top: 20px;margin-left: 0px;padding-left: 10px;min-width: 500px">
<p style="color: #AAAAAA; margin-top: 10px;">Am 17.07.2021 20:48:47 schrieb David T. Lewis <lewis@mail.msen.com>:</p><div style="font-family:Arial,Helvetica,sans-serif">On Sat, Jul 17, 2021 at 10:23:02AM -0400, Ron Teitelbaum wrote:<br>> Hi Herbert,<br>> <br>> Yeah, I thought that too and I'm sure the poll works that way but this<br>> is not scientific.<br>> <br>> Everyone,<br>> <br>> I took a look at the help browser and noticed that on the first page there<br>> is inaccurate information. Then I tried to search and hit a wide character<br>> error. Could have just been our UTF-8 version so I wondered if people are<br>> using it. I would like to see some more responses but it seems from the<br>> responses so far that this may be a viable solution.<br>> https://forms.gle/CsEpHvipoGbeud9k8<br>> <br>> Do we have a documentation team? If so, who is on it?<br>> <br>> To make the help browser more visible I think we need to have the ability<br>> to produce an online version to increase visibility but that seems like a<br>> doable project. Create an export, write some CSS, find a place to publish<br>> it, and we have something that can be found online. We may still be able<br>> to combine the help browser and use it as the source for something like<br>> https://www.sphinx-doc.org/en/master/ for the online version.<br>> <br>> If you have suggestions or ideas about a documentation project please speak<br>> up.<br>> <br>> So far the requirements are:<br>> <br>> 1. We need something that is easy enough for people to contribute.<br>> 2. Something that is easily maintained and modified<br>> 3. Something that is collaborative<br>> 4. Something that is easily discoverable<br>> 5. Something that is not easily ignored<br>> 6. Something that can be tested!<br>> 7. Something that can be versioned<br>> <br>> Thank you for your help!!<br>> <br><br>I would be happy to see a HelpBrowser/Seaside solution that does not<br>require a lot of new content creation. That said, I have to give a<br>shout out to the Cuis Book as an outstanding example of good writing<br>and content packaging. You can read the book on line or as a PDF, and<br>it is a very good piece of work either way.<br><br>The project is:<br> http://lists.squeakfoundation.org/pipermail/squeak-dev/2021-July/216008.html<br><br>which links to the on line book here:<br> http://lists.squeakfoundation.org/pipermail/squeak-dev/2021-July/216008.html<br><br>Dave<br><br><br></div></blockquote></div>