zellij icon indicating copy to clipboard operation
zellij copied to clipboard

Improve user documentation

Open raphCode opened this issue 2 years ago • 2 comments

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:

  • man page
  • online docs
  • zellij --help
  • statusbar tips

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:

  • [ ] mention the feature to open a new tab with a predefined tab-layout in the Layouts section to help with discoverability https://github.com/zellij-org/zellij/issues/742#issuecomment-1125965282
  • [x] Layout file: show how to run commands and drop into an interactive shell afterwards https://github.com/zellij-org/zellij/issues/1099 to really get an interactive shell with some commands pre-executed, it is better to use a startup script file or doing it inline in the layout config: run: command: {cmd: bash, args: ["-c", "exec bash --init-file <(echo \"set -m; source .bashrc; cd <somewhere>; vim -S\") -i"]}
  • [x] https://github.com/zellij-org/zellij/issues/1377
  • [ ] On the discord there was some confusion about how floating panes work

Related issues:

  • https://github.com/zellij-org/zellij/issues/938
  • https://github.com/zellij-org/zellij/issues/1202

raphCode avatar May 13 '22 12:05 raphCode

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:

  • interactive tutorial in the terminal, like vimtutor
  • online tutorial with commands / keystrokes to follow along
  • asciinema video

raphCode avatar May 13 '22 12:05 raphCode