docs: proof-read edits

[jamestrew]

Description

Proof-read edits of the help docs. Mostly related to spelling/grammar errors, minor formatting clean ups and other nitpicks.

Type of change

• This change requires a documentation update

How Has This Been Tested?

Read through of the docs - still wip

Configuration:

• Neovim version (nvim --version): NVIM v0.9.0-dev-590+g6ba34e21f
• Operating system and version: Linux archlinux 6.1.2-arch1-1

Checklist:

• My code follows the style guidelines of this project (stylua)
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (lua annotations)

[jamestrew]

@Conni2461 @fdschmidt93 sorry guys, it looks like the docgen action is failing for me:

Run # We have to build the parser every single time to keep up with parser changes
fatal: reference is not a tree: 86f74dfb69c570f0749b241f8f5489f8f50adbea
Error: Process completed with exit code 128.

Can't really review my changes without it.

On a related note, with help docs tree-sitter being a thing, it would be possible to have syntax highlighting for lua code blocks provided the docgen code supports it. I'd offer to go through the docs again to add the lua tags.

[Conni2461]

thanks for pining, docgen ci should be fixed on master.

On a related note, with help docs tree-sitter being a thing, it would be possible to have syntax highlighting for lua code blocks provided the docgen code supports it. I'd offer to go through the docs again to add the lua tags.

Didn't know about that. i try to add support but first i need to check why tree-sitter lua master isnt working as expected. Thats why we are checking out 86f74dfb69c570f0749b241f8f5489f8f50adbea

[Conni2461]

LGTM thanks :)

I've made a todo for syntax highlighting and try to work on it soonish