From e997c017deab234a0a067914d7bb6e81e3fa9d88 Mon Sep 17 00:00:00 2001
From: Carwin Young <715967+carwin@users.noreply.github.com>
Date: Sun, 18 Jul 2021 12:31:34 -0500
Subject: [PATCH] (docs): adjusted configuration examples for backlinks buffer
 (#1610)

- Fixed the original example's extra parenthesis, which broke the alist.
 - Added a second example for configuring the buffer as a side window.
---
 doc/org-roam.org  | 24 +++++++++++++++++++-----
 doc/org-roam.texi | 24 +++++++++++++++++++-----
 2 files changed, 38 insertions(+), 10 deletions(-)

diff --git a/doc/org-roam.org b/doc/org-roam.org
index 90e1994..994758c 100644
--- a/doc/org-roam.org
+++ b/doc/org-roam.org
@@ -519,11 +519,11 @@ the user. The author's recommended configuration is as follows:
 
 #+begin_src emacs-lisp
   (add-to-list 'display-buffer-alist
-               '(("\\*org-roam\\*"
-                  (display-buffer-in-direction)
-                  (direction . right)
-                  (window-width . 0.33)
-                  (window-height . fit-window-to-buffer))))
+               '("\\*org-roam\\*"
+                 (display-buffer-in-direction)
+                 (direction . right)
+                 (window-width . 0.33)
+                 (window-height . fit-window-to-buffer)))
 #+end_src
 
 Crucially, the window is a regular window (not a side-window), and this allows
@@ -533,6 +533,20 @@ for predictable navigation:
   Org-roam buffer.
 - ~C-u RET~ navigates to thing-at-point in the other window.
 
+For users that prefer using a side-window for the org-roam buffer, the following
+example configuration should provide a good starting point:
+
+#+begin_src emacs-lisp
+  (add-to-list 'display-buffer-alist
+               '("\\*org-roam\\*"
+                 (display-buffer-in-side-window)
+                 (side . right)
+                 (slot . 0)
+                 (window-width . 0.33)
+                 (window-parameters . ((no-other-window . t)
+                                       (no-delete-other-windows . t)))))
+#+end_src
+
 ** TODO Styling the Org-roam buffer
 * Node Properties
 ** Standard Org properties
diff --git a/doc/org-roam.texi b/doc/org-roam.texi
index 29860f2..5dca0e7 100644
--- a/doc/org-roam.texi
+++ b/doc/org-roam.texi
@@ -818,11 +818,11 @@ the user. The author's recommended configuration is as follows:
 
 @lisp
 (add-to-list 'display-buffer-alist
-             '(("\\*org-roam\\*"
-                (display-buffer-in-direction)
-                (direction . right)
-                (window-width . 0.33)
-                (window-height . fit-window-to-buffer))))
+             '("\\*org-roam\\*"
+               (display-buffer-in-direction)
+               (direction . right)
+               (window-width . 0.33)
+               (window-height . fit-window-to-buffer)))
 @end lisp
 
 Crucially, the window is a regular window (not a side-window), and this allows
@@ -837,6 +837,20 @@ Org-roam buffer.
 @code{C-u RET} navigates to thing-at-point in the other window.
 @end itemize
 
+For users that prefer using a side-window for the org-roam buffer, the following
+example configuration should provide a good starting point:
+
+@lisp
+  (add-to-list 'display-buffer-alist
+               '("\\*org-roam\\*"
+                 (display-buffer-in-side-window)
+                 (side . right)
+                 (slot . 0)
+                 (window-width . 0.33)
+                 (window-parameters . ((no-other-window . t)
+                                       (no-delete-other-windows . t)))))
+@end lisp
+
 @node Styling the Org-roam buffer
 @section @strong{TODO} Styling the Org-roam buffer