unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Improving documentation of Org Mode integration into Emacs.
@ 2021-12-04 21:14 Karl Fogel
  2021-12-04 21:18 ` Karl Fogel
                   ` (3 more replies)
  0 siblings, 4 replies; 32+ messages in thread
From: Karl Fogel @ 2021-12-04 21:14 UTC (permalink / raw)
  To: Emacs Development

I'd like to improve our in-tree documentation of how Org Mode 
integration into GNU Emacs works.

Many of us know from experience that Org Mode is maintained in a 
separate repository at git://git.sv.gnu.org/emacs/org-mode.git, 
and that it has its own project home site at https://orgmode.org/. 
But to a newcomer or an occasional contributor, this isn't 
obvious: they just see the sources in 'lisp/org/', looking like 
any other Lisp subdir in Emacs.

The fact that Org Mode is special is not clearly documented for 
those whose entry point is the Emacs sources.  While "orgmode.org" 
is mentioned in a header comment in, e.g., 'org.el', it's not 
prominent, and it's especially easy to miss because one often 
lands in the middle of a .el file via etags or grep or some other 
method that doesn't involve entering through the top.

And even for those who do happen to know that Org Mode is special, 
we can't tell from inspection exactly what 'lisp/org/' represents. 
Is it a release of Org Mode?  A regularly-updated clone of the 
upstream development sources?  Something else?

I finally found 
https://orgmode.org/worg/org-maintenance.html#org9ffe058, which 
describes how it works.

So I'd like to add some documentation in our tree, clarifying this 
situation for future searchers.  Most likely, this would be a 
brief mention in CONTRIBUTE, pointing to a new file 
lisp/org/README which would give more details and point to the 
above page.

Any objections / thoughts / suggestions about this, before I start 
on it?
 
Best regards,
-Karl

[2] https://list.orgmode.org/87czmcccrp.fsf@red-bean.com/T/#u



^ permalink raw reply	[flat|nested] 32+ messages in thread

end of thread, other threads:[~2022-01-11  7:49 UTC | newest]

Thread overview: 32+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-04 21:14 Improving documentation of Org Mode integration into Emacs Karl Fogel
2021-12-04 21:18 ` Karl Fogel
2021-12-04 22:09 ` [External] : " Drew Adams
2021-12-05  5:16 ` Stefan Monnier
2021-12-05  6:38 ` Eli Zaretskii
2022-01-03  5:05   ` Karl Fogel
2022-01-03  5:44     ` Stefan Monnier
2022-01-05  3:09       ` Karl Fogel
2022-01-05 13:48         ` Eli Zaretskii
2022-01-05 14:17           ` Michael Albinus
2022-01-05 14:26             ` Eli Zaretskii
2022-01-06 12:40               ` Michael Albinus
2022-01-06 13:58                 ` Eli Zaretskii
2022-01-07 10:41                   ` Protesilaos Stavrou
2022-01-09 22:34           ` Karl Fogel
2022-01-10  8:46             ` Michael Albinus
2022-01-10  9:03               ` Michael Albinus
2022-01-10  9:13                 ` Karl Fogel
2022-01-10  9:17                   ` Michael Albinus
2022-01-10 11:01                   ` Robert Pluim
2022-01-10 16:10                     ` Karl Fogel
2022-01-10  9:06               ` Karl Fogel
2022-01-10  9:24                 ` Michael Albinus
2022-01-10 16:20                   ` Karl Fogel
2022-01-10 18:24                     ` Eli Zaretskii
2022-01-11  7:49                       ` Michael Albinus
2022-01-10 18:14             ` Eli Zaretskii
2022-01-10 19:08               ` Karl Fogel
2022-01-03  8:52     ` Michael Albinus
2022-01-03 12:06     ` Protesilaos Stavrou
2022-01-03 13:31     ` Eli Zaretskii
2022-01-03 20:45     ` Rudolf Adamkovič

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).