<div dir="auto">There are also the HelpTopic classes. WebClient has some IIRC. Since the texts reside in those classes, they would be placed next to the code in the package.</div><div class="gmail_extra"><br><div class="gmail_quote">Am 23.06.2017 21:03 schrieb "Juan Vuletich" <<a href="mailto:JuanVuletich@zoho.com">JuanVuletich@zoho.com</a>>:<br type="attribution"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
On 6/23/2017 2:01 PM, tim Rowledge wrote:<br>
><br>
><br>
>> On 23-06-2017, at 9:45 AM, Eliot Miranda<<a href="mailto:eliot.miranda@gmail.com">eliot.miranda@gmail.<wbr>com</a>>  wrote:<br>
>><br>
>> To the general audience, I think information like the above is key to being able to understand and exploit the system effectively, but where should it reside?  Clearly "in my head" is not satisfactory.  It belongs somewhere in the image, but it needs to be somewhere where people can find it and/or will look.  Suggestions for an "architectural information" documentation section gratefully received.  Object class>>whatIsAPrimitive might perhaps work or perhaps be overloaded.<br>
> A brief explanation in the sources as a comment for the class and/or some relevant methods *plus* a link to a swiki page with the full details. The briefest explanation might well be as little as “this is a quite complex issue; see <a href="http://swiki.squeak.org/85643505485" rel="noreferrer" target="_blank">swiki.squeak.org/85643505485</a>"<br>
><br>
><br>
> tim<br>
> --<br>
> tim Rowledge; <a href="mailto:tim@rowledge.org">tim@rowledge.org</a>; <a href="http://www.rowledge.org/tim" rel="noreferrer" target="_blank">http://www.rowledge.org/tim</a><br>
> Useful random insult:- A .22 caliber intellect in a .357 Magnum world.<br>
<br>
But this information is for Smalltalk developers, not just for VM<br>
developers. And urls might eventually break.<br>
<br>
I think the full information on how to better use the VM belong in some<br>
file in VM sources, maybe one or several .md files. And Smalltalk<br>
systems using the VMs might chose to duplicate it in the image. I'd<br>
surely do it for Cuis.<br>
<br>
This might be too much for Object class>>whatIsAPrimitive. I think some<br>
methods in a 'documentation' category in SystemDictionary would be<br>
better. Or one (or several) new classes, just for this. Better if we can<br>
share them in all the distributions: Squeak, Pharo, Newspeak and Cuis.<br>
<br>
Thanks,<br>
<br>
--<br>
Juan Vuletich<br>
<a href="http://www.cuis-smalltalk.org" rel="noreferrer" target="_blank">www.cuis-smalltalk.org</a><br>
<a href="https://github.com/Cuis-Smalltalk/Cuis-Smalltalk-Dev" rel="noreferrer" target="_blank">https://github.com/Cuis-<wbr>Smalltalk/Cuis-Smalltalk-Dev</a><br>
@JuanVuletich<br>
<br>
<br>
</blockquote></div></div>