Commit Graph

22 Commits

Author SHA1 Message Date
har7an
49b831c032
docs: Improve error handling docs (#1919)
* docs: Improve error handling docs

and add more TL;DRs and new sections about handling specific errors, and
logging errors.

* contributing: Add more coding tips
2022-11-09 18:01:36 +00:00
har7an
0711591ad3
docs: Describe how to handle Options as errors (#1805)
* docs: Describe how to handle Options as errors

* CONTRIBUTING: Add tips for code contributions

which will be home to condensed tips and best-practices around the
zellij code. Currently explains to prefer returning `Result` types
instead of `unwrap`ing on them.

The tips in here are meant to be short, concise guides that allow the
user to get started without a lot of reading. The individual tips can
(and should) be supplemented with links to "further reading" where the
topic at hand is explained in greater detail.
2022-10-18 14:14:38 +00:00
Bohdan Ivashko
5fede55fbd
zellij-server/src/screen: improve error handling (#1770)
* zellij-server/src/screen: improve error handling

* cleanup context vs with_context usage

* update error handling docs

* zellij-server/src/screen.rs: fix formatting
2022-10-04 09:09:32 +00:00
har7an
e7bce6a106
Add docs about error handling (#1745)
* docs: Add ERROR_HANDLING

that explains how we plan to change error handling in zellij and invites
new contributors to join the fun. Details the currently existent error
handling capabilities and gives a bunch of examples taken from #1670.

* utils/errors: Shorten docblock

by moving previous content under "Help Wanted" to the new
`docs/ERROR_HANDLING` document and link to the document instead.
2022-09-27 07:28:09 +00:00
Jae-Heon Ji
580cf592c2
docs(manpage): update manpage (#1549) 2022-06-29 22:58:23 +09:00
Ken Matsui
776959eaff
Fix installation with MacPorts (#1529)
MacPorts installed in a general way requires `sudo`.
Ref: https://superuser.com/a/1413502
2022-06-19 21:25:37 +02:00
a-kenji
0cd43a5d1b
fix: update architecture-docs (#1487) 2022-06-11 15:23:11 +02:00
Kian-Meng Ang
16b53aa52f
docs: fix typos (#1481) 2022-06-10 23:37:55 +09:00
a-kenji
3ee214ef35
add(option): default_layout (#1467)
* add(option): `default_layout`

Add `option` `default_layout` / `default-layout`,
that allows specifying a different layout, that should
be loaded on start.

Eg:
```
default_layout: compact
```

* add(manpage): `default_layout`
2022-06-07 21:32:04 +02:00
Cosmin Popescu
e1fcf3a6db
feat(scroll): edit scrollback with default editor (#1456)
* initial commit for opening the current buffer in an editor

* fix(editor): take hidden panes into consideration when manipulating tiled grid

* when closing an edit buffer, take the geometry of the replaced buffer from the closed buffer

* if the floating panels are displayed, don't add to hidden panels the current buffer

* strategy changing - put the panels inside a suppressed_panels HashMap instead of hidden_panels

* Revert "strategy changing - put the panels inside a suppressed_panels HashMap instead of hidden_panels"

This reverts commit c52a203a20.

* remove the floating panes by moving them to the tiled_panes in hidden_panels

* feat(edit): open editor to correct line and don't crash when none is set

* formatting

* feat(edit): use suppressed panes

* style(fmt): rustfmt and logs

* style(fmt): clean up unused code

* test(editor): integration test for suppressing/closing suppressed pane

* test(e2e): editor e2e test

* style(fmt): rustfmt

* feat(edit): update ui and setup

* style(fmt): rustfmt

* feat(config): allow configuring scrollback_editor explicitly

* style(fmt): rustfmt

* chore(repo): build after merging

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2022-06-06 09:20:07 +02:00
a-kenji
ad9ba8ab24
add: more information to the manpage (#1443) 2022-05-30 23:31:23 +02:00
Cosmin Popescu
76d871294d
feat(actions): dump the terminal screen into a file (#1375)
* Initial commit for fixing #1353

* adding a new line between the lines_above and the viewport

* changes following code review

* implementing a test case for the dump screen

* implemented test case for dump_screen

* better regexp replace

* fixes following code review

* style(api): remove extraneous method in plugin pane

* style(fmt): rustfmt

* style(tests): fix method name

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2022-05-20 11:22:40 +02:00
Marcin Puc
d7e87e439a
docs: add installation instructions for Void Linux (#1165) 2022-03-04 08:10:50 +01:00
a-kenji
668ee145b0
docs(readme): move install docs to docs (#1150) 2022-02-28 20:32:41 +01:00
a-kenji
bd43a8aa63 docs(manpage): Update manpage 2021-05-30 21:07:44 +02:00
Kyle Sutherland-Cash
9a3e8bcb84 First round of merging against server-client and color stuff 2021-05-08 04:32:31 -07:00
a-kenji
79a4f76e93 Add more Functionality to Unbind
The default keybinds can be unbound either for a specific mode, or for every mode.
It supports either a list of `keybinds`, or a bool indicating that every keybind
should be unbound:

```
keybinds:
    unbind: true
```
Will unbind every default binding.

```
keybinds:
    unbind: [ Ctrl: 'p']
```
Will unbind every default `^P` binding for each mode.
```
keybinds:
    normal:
        - unbind: true
```
Will unbind every default keybind for the `normal` mode.
```
keybinds:
    normal:
        - unbind: [ Alt: 'n', Ctrl: 'g']
```
Will unbind every default keybind for `n` and `^g` for the `normal` mode.
2021-05-07 10:51:35 +02:00
NKGoc
00d064e349 add manpage to zellij 2021-05-04 20:50:27 +02:00
henil
30f0567d8a Update references of mosaic to Zellij in md files 2021-02-10 12:12:19 +05:30
Henil
1defd39491
docs(spelling): teack -> track (#91) 2020-12-10 10:04:29 +01:00
Aram Drevekenin
cc347ab24a
docs(architecture): fix title 2020-11-06 09:58:36 +01:00
Aram Drevekenin
ea2251e755
docs(contributing): explanations about the project arhictecture and some cheat sheet about terminal terminology (#26)
* docs(contributing): codebase documentation for new contributors

* docs(architecture): fix line breaks

* docs(terminology): fix line breaks
2020-11-06 09:57:35 +01:00