any good documentation for a beginner ?

[teto]

hi,

super happy to see an orgmode for neovim, I've heard so many good things about it that I am eager to try it but I've no idea where to start with. For instance I've created TODO tasks and was expecting them to show up in the calendar but they dont ?
These TODOs are listed in /home/teto/orgmode/refile.org instead.

Could the README recommand an adapted tutorial ? is there a chat channel to ask questions live ? like a subchannel in the neovim matrix space ?

The plugin looks polished and I can't wait to tap into the full potential of the plugin !

[levouh]

The calendar is only for choosing dates related to items; if you want to see your "schedule" you are looking for the Agenda view (opened with <leader>oa by default).

Orgmode is a general enough "task management" tool that I'm not sure a generalized tutorial would be incredibly useful. Perhaps individual tutorials for each of the separate features might be useful, then the user can integrate them into their workflow as needed.

Not sure where something like that would start, but the general ask around "I have no clue how Orgmode works" is a seemingly common problem @kristijanhusak. I've never really found a good "meta-level" discussion about Orgmode (there are some for things like GTD, e.g. here or here), and most examples (e.g. here and the previous links) are Emacs-specific (as you would expect).

Also a Discord or Matrix channel would be awesome 😉

[teto]

thanks for the answer, if I open t List of all TODO entries I see my TODO entries.
If I look at section 3 of https://whhone.com/posts/org-mode-task-management/ , he sees his TODO items directly in the weekly calendar. Why don't I ? Right now, I've in my refile.org

* TODO post on the blog
  sdadasda
  [2021-12-12 Sun]
  DEADLINE: <2020-11-07 Sat> SCHEDULED: <2020-10-31 Sat>
* TODO support mptcp versions 0 and 1
  adasdasdas
  [2021-12-12 Sun]

As for a room, @clason has been trying to regroup plugins in a neovim subspace for ease of discoveribility in https://app.element.io/#/room/#neovim_space:matrix.org so if there is interest, we could create one there.

[kristijanhusak]

I never really planned to have a "teaching section" on how to use Orgmode. I believe that if someone knows to use Orgmode in Emacs, they shouldn't have any problems figuring things out here.
Do you know how Emacs is handling this? I know they have a subreddit, but I wouldn't go that far. Regarding Matrix or Discord, I'm not really using any of those, but feel free to set up a space there if it will help someone.
I guess having dedicated github pages with some "Getting started" for now would be helpful.

I'll create an issue for this with a "Help needed" label, and I hope someone will jump into doing that. I'm trying to focus my free time on adding new features.

@teto you can look into this video to get a little idea how orgmode works https://www.youtube.com/watch?v=nsv33iOnH34 . It's a different plugin, but most of the ideas from there are similar.

[kristijanhusak]

I added this link to the Getting started section in docs for now.

[halfdan]

For me the problem is that I'm not an emacs user and don't want to be. Having some sort of documented "happy path" for basic note taking and task management would allow me to ramp up much faster when this plugin is my very first interaction with orgmode.

[jgollenz]

@halfdan it seems we're having a hard time doing this properly. Do you have any examples of other repos/tools that have provided you with a useful happy path from which we can get some inspiration?

[jgollenz]

@kristijanhusak let's please talk about this. I don't think we have given documentation enough attention. Even if this were a perfect port of orgmode, if people don't know how to use it, there is little point in it. Some thoughts I have:

• The github pages were a good start, but I hardly remember that they even exist. Are they in sync with the current state of the repo? How do we make sure they stay in sync?
• What about the 'Wiki' section of a github repo? In my opinion it helps to keep the whole thing a bit more compact (in the sense of 'everything is at a single place'), although it gives you less flexibility on how exactly you want to lay out your docs. In any case, having both github pages and a wiki is probably not a good idea.
• A 'getting started' section has been missing for far too long.
• The 'DOCS' link in the README links to DOCS.md. The link to the 'Getting started' section is not easy to find when just skimming through the README. This might leave users with the impression that there is no 'getting started' section (let's ignore the fact that this is currently true for a second)
• The headline levels of the README also seem to be out of sync, the links on top don't cover items on the same level. The ones with the same level are
  • Installation
  • Setup
  • Plugins
  • Development
  • Plans (has no link on top)
  • Kudos

but we also have
- Troubleshoot
- Gifs
- Docs
- Tree-sitter info
linked at the top, giving the impression that all of them are on the same level

Since multiple people have requested it, I made a matrix room: https://matrix.to/#/#neovim-orgmode:matrix.org

[kristijanhusak]

Everything that is in a github wiki is part of a separate repo, in our case it is nvim-orgmode/orgmode.wiki.git

TIL. That's very neat.

Perhaps there is a way how we can take those, process them accordingly so ReadTheDocs can work with them and continue to host them with github pages. Perferable automated at every change to the wiki.

This would be awesome, and seems plausible possible.

[jgollenz]

@kristijanhusak if you create a wiki section for the repo I'll start with adding a 'getting started' tutorial 🙂

[kristijanhusak]

@jgollenz should be unlocked now. I thought it was already open.

[d-r-jenkins]

Since some people asked for input from an emacser, I first learned org in emacs-land, and recently moved to Neovim, and I started with org mode here: https://orgmode.org/guide/ and then googled a lot and found blogs, which of course there is a lot more for emacs-lisp customisation than for lua.

I would in principle be up for helping with beginner docs (I know basically no lua, so probably can't help updating the technical docs). I will have time this Sunday to write something, so if nothing has appeared in the wiki section by then should I just go for it? Or is there somewhere else that this is being developed?

[jgollenz]

I'd love some help ❤️ it's probably easiest to discuss it on the matrix channel

[jgollenz]

@teto we now have a Getting Started section in our wiki. Please have a look at it and tell us what you think 👍

[teto]

thanks a lot, that's what I was looking for. Some examples of https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started#links seem to lack either a [ or ].
I believe org has many features so might be worth using subtrees in the outline, the most interesting aspect to me for instance is "literate programming" aka "babel" (I think ?!)with #+BEGIN_SRC markers. I dont think it's quite available yet but really looking forward to that.

I am also curious as to what "refiling" means.

[jgollenz]

Thanks for catching the missing brackets, should be fixed now.

I think literate programming is a large enough topic for it's own page, but a short example in the 'First Steps' sounds like a good idea 👍

@teto @aareman btw, you both (and everybody else) should be able to just edit the wiki pages. Whenever you spot errors or want to improve something, feel free to do so 🙂

[aareman]

Refiling means moving a heading tree to a new location. Like refiling from one filing cabinet to another. You can also refile it under another heading in the same or different files.

…

________________________________ From: Matthieu Coudron ***@***.***> Sent: Tuesday, November 15, 2022 6:54:41 PM To: nvim-orgmode/orgmode ***@***.***> Cc: Subscribed ***@***.***> Subject: Re: [nvim-orgmode/orgmode] any good documentation for a beginner ? (Discussion #182) thanks a lot, that's what I was looking for. Some examples of https://github.com/nvim-orgmode/orgmode/wiki/Getting-Started#links seem to lack either a [ or ]. I believe org has many features so might be worth using subtrees in the outline, the most interesting aspect to me for instance is "literate programming" aka "babel" (I think ?!)with #+BEGIN_SRC markers. I dont think it's quite available yet but really looking forward to that. I am also curious as to what "refiling" means. — Reply to this email directly, view it on GitHub<#182 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACQDVV7OF7YAGI3HPQQ7AITWIQPEDANCNFSM5J4MPX3Q>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[ryflamm]

I think it would be helpful to have an example org file/directory people can download and poke around. And yes, I know I can find emacs org files out in the wild... but those may have things that nvim-orgmode doesn't support (yet) or has implemented a bit differently. For instance, best I can tell nvim implementation doesn't support top of file properties like #+STARTUP: indent align overview to set file specific behaviors, tags, etc.