From 36a470374b3dcc1b6a55bc84b6b806e3fee6448b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Th=C3=A9riault?=
 <13123390+rempsyc@users.noreply.github.com>
Date: Sat, 28 Oct 2023 11:37:13 -0400
Subject: [PATCH] update docs

---
 NEWS.md      | 5 ++++-
 R/use.R      | 8 ++++++++
 altdoc.Rproj | 1 +
 man/init.Rd  | 7 +++++++
 4 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/NEWS.md b/NEWS.md
index 294578e5..2a30b20b 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -14,7 +14,10 @@
 
 * Vignettes are no longer automatically added to the file that defines the structure
   of the website. Developers must now manually update this structure and the order
-  of their articles.
+  of their articles. Note that the name of the file defining the structure of the 
+  website differs based on the selected site builder. This file lives at the root
+  of `/docs` (`use_docsify()` = `_sidebar.md`; `use_docute()` = `index.html`; 
+  `use_mkdocs()` = `mkdocs.yml`).
   
 
 ### Major changes
diff --git a/R/use.R b/R/use.R
index c3ea966b..139241ae 100644
--- a/R/use.R
+++ b/R/use.R
@@ -11,6 +11,14 @@
 #'
 #' @return No value returned. Creates files in folder 'docs'. Other files and
 #' folders are not modified.
+#'
+#' Note that vignettes are no longer automatically added to the file that
+#' defines the structure of the website. Developers must now manually update
+#' this structure and the order of their articles. The name of the file defining
+#' the structure of the website lives at the root of `/docs` and differs based
+#' on the selected site builder (`use_docsify()` = `_sidebar.md`;
+#' `use_docute()` = `index.html`; `use_mkdocs()` = `mkdocs.yml`).
+#'
 #' @rdname init
 #'
 #' @examples
diff --git a/altdoc.Rproj b/altdoc.Rproj
index 497f8bfc..270314b8 100644
--- a/altdoc.Rproj
+++ b/altdoc.Rproj
@@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace
diff --git a/man/init.Rd b/man/init.Rd
index 4d31520b..96ac9c64 100644
--- a/man/init.Rd
+++ b/man/init.Rd
@@ -33,6 +33,13 @@ section.}
 \value{
 No value returned. Creates files in folder 'docs'. Other files and
 folders are not modified.
+
+Note that vignettes are no longer automatically added to the file that
+defines the structure of the website. Developers must now manually update
+this structure and the order of their articles. The name of the file defining
+the structure of the website lives at the root of \verb{/docs} and differs based
+on the selected site builder (\code{use_docsify()} = \verb{_sidebar.md};
+\code{use_docute()} = \code{index.html}; \code{use_mkdocs()} = \code{mkdocs.yml}).
 }
 \description{
 Init Docute, Docsify, or Mkdocs