Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve user documentation #1416

Open
2 of 4 tasks
raphCode opened this issue May 13, 2022 · 2 comments
Open
2 of 4 tasks

Improve user documentation #1416

raphCode opened this issue May 13, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@raphCode
Copy link
Contributor

raphCode commented May 13, 2022

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 Feature: apply layout at runtime #742 (comment)
  • Layout file: show how to run commands and drop into an interactive shell afterwards Run multiple commands in layouts #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"]}
  • Better document the Tab|Sync command #1377
  • On the discord there was some confusion about how floating panes work

Related issues:

@raphCode
Copy link
Contributor Author

raphCode commented May 13, 2022

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 raphCode added the documentation Improvements or additions to documentation label May 13, 2022
@robert-matusewicz
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants