search

nvim-orgmode / orgmode

Orgmode clone written in Lua for Neovim 0.9+.
https://nvim-orgmode.github.io/
MIT License
3k stars 131 forks source link

[Help needed] Documentation - Github pages #183

Open kristijanhusak opened 2 years ago

kristijanhusak commented 2 years ago

A lot of people are confused how to start using the plugin, since they don't know how Orgmode generally works.

Having dedicated github pages with at least a "Getting started" section would be helpful.

I'm focusing my time on adding new features, so if anyone who knows Orgmode would jump on this, that would help a lot.

jmrussell commented 2 years ago

Are you thinking of a guide that explains how to use orgmode (outside of the context of this plugin specifically) and focuses on things like using organizing projects using org mode etc? I would like to contribute since I don't know nearly enough Lua to do anything but suggest features I'd like ;)

levouh commented 2 years ago

IMO Org is a flexible enough tool that:

how to use orgmode

would seemingly be too focused on a particular workflow. I might refine that down a bit to say something like:

how specific parts of Orgmode work

like the agenda view, etc. leaving it a bit more up to user interpretation and how those tools might fit into their own workflow.

So I would imagine the topics break down something like:

  1. Creating TODO items
  2. Defining and moving TODO items between states
  3. Adding dates to TODO items
  4. Viewing scheduled TODO items
  5. Adding a priority to TODO items
  6. Capturing a TODO item
  7. Refiling a TODO item

and so forth; the emphasis being that these items are "workflow agnostic", at least to start.

This is not to say that specific workflows should be completely avoided (e.g. GTD, organizing projects, creating grocery lists, etc.) but it should instead focus more on showing users how to create their own workflows using Org. It would probably be useful towards the end once all the "pieces" have been enumerated to go over a sample workflow that uses different ones to make up a complete workflow.

That is my 2 cents @jmrussell.

ourigen commented 2 years ago

orgmode.org is also a great beginner-friendly source that we perhaps can just link to. The homepage and the "Features" tab touch on the main concepts and syntax of orgmode in a digestible way

hakling commented 2 years ago

I'm willing to put in some time on this starting in a week or two.

ghost commented 2 years ago

@kristijanhusak what is the best way to help/support you here? (Love the plugin btw :D can finally uninstall emacs which was only used for org-mode)

kristijanhusak commented 2 years ago

@Liberatys I think Lukas summarized it here very well. We could have a dedicated github pages website with some documentation and "Getting started" section.

gerazov commented 2 years ago

I created a PR #267 with a Read the Docs themed Sphinx version of the README plugged into GitHub Pages. I've also added a Getting Started section as outlined by @levouh

It looks really nice :sunglasses: https://gerazov.github.io/orgmode/

It could be the platform we use to publish documentation. Deployment should be automated though as in Continuous Documentation: Hosting Read the Docs on GitHub Pages

gerazov commented 2 years ago

Moved the PR to the new documentation repo: https://github.com/nvim-orgmode/docs/pull/1

kristijanhusak commented 2 years ago

Github pages are up: https://nvim-orgmode.github.io/

Repo: https://github.com/nvim-orgmode/nvim-orgmode.github.io.

Thanks @gerazov for taking an initiative on this!

gerazov commented 2 years ago

Glad to help :love_you_gesture: