Skip to content

Commit

Permalink
clarify vignettes explanations
Browse files Browse the repository at this point in the history
  • Loading branch information
rempsyc committed Oct 28, 2023
1 parent a3a6d68 commit 1e9703e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
12 changes: 7 additions & 5 deletions R/use.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
#' @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`;
#' @details
#' # Vignettes
#' Note that although vignettes are automatically moved to the `/docs` folder,
#' they are no longer automatically specified in the website structure-defining
#' file. Developers must now manually update this file and the desired order of
#' their articles. This file lives at the root of `/docs` and its name differs
#' based on the selected site builder (`use_docsify()` = `_sidebar.md`;
#' `use_docute()` = `index.html`; `use_mkdocs()` = `mkdocs.yml`).
#'
#' @rdname init
Expand Down
16 changes: 9 additions & 7 deletions man/init.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1e9703e

Please sign in to comment.