Hi, This goes in the same line I have proposed in this thread (but I answered before coming to this particular message). I think that this idea of documenting a new feature via a small notebook that implements that would help to bridge the gap between the documentation and the mailing list.
Cheers, Offray On 10/10/18 11:53 PM, 'tfer' via leo-editor wrote: > I'm glad this came up, I was going to say something on this under the > title: "Leo, an embarrassment of riches that are too well hidden." > > I was involved in another editor in the past, in it we followed > another convention for documentation. Say you added support for > another language, well, along with the plugin to support it, you > created a file to talk about its features and demonstrate them. This > file was a "live document", for example, it would talk about a certain > type of completion it added, then have a code block that once you > entered enabled the language-mode, let you jump to point where there > was a hint that could completed, and let you hit the tab to try out > the completion. Note that these demo-files where opened from > templates so you weren't making changes to them when you explored them. > > So to generalize this, I'm suggesting that there be an Examples > directory in the distribution, where any file in it or a sub directory > of it is treated as such a template. It would contain live documents > for plugins, workflows, debugging demos, design notes, generic add a > language demo, unit test demo, todo plugin demo, etc. > > So, now the Leo supports Jupyter notebooks, I imagine a lot of this > stuff will use that format, but I don't know, because I've never tried > that in Leo, there aren't any examples. :-) > > Tom > -- > You received this message because you are subscribed to the Google > Groups "leo-editor" group. > To unsubscribe from this group and stop receiving emails from it, send > an email to [email protected] > <mailto:[email protected]>. > To post to this group, send email to [email protected] > <mailto:[email protected]>. > Visit this group at https://groups.google.com/group/leo-editor. > For more options, visit https://groups.google.com/d/optout. -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/leo-editor. For more options, visit https://groups.google.com/d/optout.
