zellij-org / zellij

A terminal workspace with batteries included
https://zellij.dev
MIT License
21k stars 641 forks source link

Improve user documentation #1416

Open raphCode opened 2 years ago

raphCode commented 2 years ago

This is a general tracking issue for what should be improved in the user facing documentation.

A problem is that some information is not documented at all or only at some places, because we provide multiple documentation locations:

Ideally, most / all information is available everywhere (as long as it is reasonable) because we can't expect users to check multiple places. Also, I guess most users don't expect another documentation location if they find one place.

Checklist of small documention issues I noticed:

Related issues:

raphCode commented 2 years ago

Maybe some basic tutorial would be helpful to lower any starting hurdles for newcomers and familiarize them with the workflows and concepts of zellij.

It could be in these forms:

robert-matusewicz commented 3 months ago

I don't want to open new issue, so will put my observation here: the old documentation contains the description of modes: https://zellij.dev/old-documentation/keybindings-modes but the new one have only list of them: https://zellij.dev/documentation/keybindings-modes

Is there a reason for that or it was just not-ported yet?