Add neorg file reference and docs to wiki page

nvim-neorg / neorg

Modernity meets insane extensibility. The future of organizing your life in Neovim.

GNU General Public License v3.0

6.32k stars 209 forks source link

Add neorg file reference and docs to wiki page #1395

Open Hoverth opened 5 months ago

Hoverth commented 5 months ago

Issues

[X] I have checked existing issues and there are no existing ones with the same request.

Feature description

Hello, As a newcomer, the documentation seems to be directed mainly at developers and/or power users, and after going through the repo and finding the doc/*.norg files (which are a great reference by the way), I was wondering if they could be more directly linked to or embedded in the wiki?

Help

Yes, but I don't know how to start. I would need guidance.

Implementation help

How are GitHub wiki pages edited? I may be able to figure it out, but some pointers would definitely be appreciated.

benlubas commented 5 months ago

@Hoverth the stuff in doc/ is for help pages. :h neorg will show you neorg.norg and the cheatsheet file is supposed to show up for :h neorg-cheatsheet but the tags are broken I think

Hoverth commented 5 months ago

I believe those do work, just as someone new coming into neorg, I did not know that they were there without watching vyrro's videos on neorg.

I'm primarily suggesting that there is something in the README.md or wiki to point new users to those commands and/or files, just to improve accessibility and prevent confusion from newcomers.

Hoverth commented 5 months ago

I've just gone through the wiki, and this time I've managed to find the tutorial page, so there is a reference to the norg file format. Maybe I was just too tired when setting neorg up that I missed it, or it's a bit out-of-the-way.

I do however suggest that the :h Neorg command be listed somewhere in the wiki, as I can't seem to find it at the moment, and it was a great help to me.