Re: Improving documentation of Org Mode integration into Emacs.

[Karl Fogel]

On 05 Dec 2021, Eli Zaretskii wrote:
> > I'd like to improve our in-tree documentation of how Org Mode 
> > integration into GNU Emacs works.
>
> Thanks.  Can you provide a rough sketch, in the form of list of 
> items,
> of what you'd like to document, and who would be the main 
> audience for
> that?  I don't have a clear idea of that based on what you 
> posted.

Sure.  (The attached patch may answer your questions more 
efficiently, though.)

* Audience:

The audience is Emacs developers and potential developers who are 
tracking down bugs, or trying to contribute enhancements, but who 
don't know that certain packages (such as Org Mode) are externally 
maintained. 

It's better for us all if such a person finds out as soon as 
possible where the active upstream for a package is.  For example, 
if they've found a bug in Org Mode, they should take the bug 
report to the Org Mode forums and discuss it with the Org Mode 
maintainers.  (Maybe sometimes Emacs Devel should also be 
involved, but the person should at least start out in the proper 
upstream forum and then be guided appropriately from there.)

* List of items:

All the packages that ship as part of Emacs but that are 
externally maintained.  Right now, Org Mode is the only one I know 
of, but I suspect there are others.  If people would like to point 
others out to me, I'll update the attached patch to include them 
too.

The attached patch is an attempt to document this situation in 
such a way that developers are likely to encounter the 
documentation when they most need it.  Comments welcome; I'm 
certainly open to other strategies.

Best regards,
-Karl

0001-Document-external-maintenance-of-some-packages.patch
Description: [PATCH] Document external maintenance of some packages