Ihor Radchenko <[email protected]> writes:
> Looks like a number of people are confused about the wording of the
> index page. That's good feedback from people not familiar with Emacs
> and Org mode. Maybe we should consider addressing the confusion points raised.

Indeed, there are some fair points that I tend to overlook after so many
years as a user.

Here's what I see (combining points from Y and things that strike me as
I try to take a fresh look):

1. Move down the section "Worg documentation on your machine"

2. Possibly move this up to the very beginning: "The page you're
   reading ... maintained by a group of Worg contributors, and maybe
   you". Or possibly leave it after the introductory paragraph on Org.

3. Remove the slightly cryptic "Worg sources are hosted here" link (it's
   redundant with the cloning section).

4. Explain the "Worg" name and how it's wiki-like but org/git-based.
   Add link to the https://orgmode.org/worg/worg-about.html in the
   first paragraphs.

5. The role of Worg within orgmode.org is already well explained, but
   perhaps add a word about the /rest/ of the site being official
   project documentation.

6. In the section "Worg documentation on your machine", add
   explanation /why/ you'd want to download it.

7. There is some overlap between worg/index.org and
   worg/worg-about.org. It needs more thinking about, but:

   - The opening paragraphs of index.org should themselves provide basic
     "about" info. The changes above should help.

   - More than an about page, worg-about.org is really the structured
     guide to contributing. We can keep the brief link list under
     [[worg/index.org::Worg maintenance]], but highlight that the first
     link -- to worg-about.org -- provides further guidance on how to
     contribute. (A link on the detail level of "How to create your own
     SSH key" probably belongs in worg-about, not on the index page.)

8. I'm very open to ideas how to structure the links to Worg resources
   to make it easier to get an at-a-glance overview and discover
   resources, as well as views on what are the priority resources to
   highlight.

   - The tutorials index page already tops the list. That's good.
   - As long as we keep the Babel-languages docs on Worg, it should
     perhaps be highlighted more.
   - At the risk of clutter, new users could probably use some direct
     links to things like sample configs for agenda views and capture
     templates.

Opinions? Other points?

Regards,
Christian







Reply via email to